diff --git a/core/src/internal_mod.ts b/core/src/internal_mod.ts index 70385dee..af2e089f 100644 --- a/core/src/internal_mod.ts +++ b/core/src/internal_mod.ts @@ -146,6 +146,8 @@ export { isIPV4OrHostname, Servers } from "./servers.ts"; export { wsconnect, wsUrlParseFn } from "./ws_transport.ts"; +export type { WsConnectionOptions, WsSocketFactory } from "./ws_transport.ts"; + export { AuthorizationError, ClosedConnectionError, diff --git a/core/src/mod.ts b/core/src/mod.ts index a402cd63..37dfe36c 100644 --- a/core/src/mod.ts +++ b/core/src/mod.ts @@ -105,4 +105,6 @@ export type { TlsOptions, TokenAuth, UserPass, + WsConnectionOptions, + WsSocketFactory, } from "./internal_mod.ts"; diff --git a/core/src/ws_transport.ts b/core/src/ws_transport.ts index 42e922bb..70fd80ee 100644 --- a/core/src/ws_transport.ts +++ b/core/src/ws_transport.ts @@ -33,11 +33,26 @@ import { errors, InvalidArgumentError } from "./errors.ts"; const VERSION = version; const LANG = "nats.ws"; +/** + * WsSocketFactory is a factory that returns a WebSocket and a boolean + * indicating if the connection is encrypted. Client code is responsible + * for creating a W3C WebSocket compliant transport. + * + * @param u the url to connect to + * @param opts the connection options + * @returns a promise that resolves to a WebSocket and a boolean indicating if + * the connection is encrypted + */ export type WsSocketFactory = (u: string, opts: ConnectionOptions) => Promise<{ socket: WebSocket; encrypted: boolean; }>; -interface WsConnectionOptions extends ConnectionOptions { + +/** + * WsConnectionOptions exposes wsconnect specific options not applicable to + * other transports. + */ +export interface WsConnectionOptions extends ConnectionOptions { wsFactory?: WsSocketFactory; } @@ -334,7 +349,7 @@ export function wsUrlParseFn(u: string, encrypted?: boolean): string { } export function wsconnect( - opts: ConnectionOptions = {}, + opts: ConnectionOptions | WsConnectionOptions = {}, ): Promise { setTransportFactory({ defaultPort: 443, diff --git a/docs/core/assets/hierarchy.js b/docs/core/assets/hierarchy.js index f7bd283d..5c871c5c 100644 --- a/docs/core/assets/hierarchy.js +++ b/docs/core/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJx1j80KwjAQhN9lz6k/kVbJE+jBJ5AeQpLaYH5KNp5K3t2NYhXE08LMtzPMDCnGjCAu3X7TM0hmcEZlGwNpM/B2V0+Q3oCAM16POuHJTw4Y3GzQILb8wOCeHNnKSUSD6y9sNWZf2adFSEbd1L/mJRQGVPvbsKTztnun25BNGqT6FPwNX9BqjtbpZAItpDF9KeUBdypPlg==" \ No newline at end of file +window.hierarchyData = "eJyVzz8LwjAQBfDv8ub4L3hRs7roII4O4lDaqMU0Lbk4Sb67xKoUVNQpkHuP390Fvq4DQ29JklA02Ql4s7cmD2XtGPoCOVbpcVlloLHiw6LwvKwaC4FT6QrokZwKnL2FRm4zZsODTqx/DFXK3kbQCFz0Uq/XfkQBktQR5rVzLb9u2iUejiT1cEoXjN9nueHBS/4j+Cyl4bG0hTcOejuj4S4KKJq83vnFvqf+FeVYJXFGw4644X8vf9P4YZMY4xWf+6dF" \ No newline at end of file diff --git a/docs/core/assets/navigation.js b/docs/core/assets/navigation.js index c6eed50e..df4e2e41 100644 --- a/docs/core/assets/navigation.js +++ b/docs/core/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJylmEt32zYQhf+L1k7buInbeufKzonaylHsJF3kZAGRIwkRCLAAKFvt6X8v+BIBAhiwylK8935DCuTg8fmfmYZnPbue8T0c1exiVhK9Mz8LkVcM1PfN5e92umBG21Oez65fXcwyRpQyLq3yF1S9MASQnNSWbEdZLoHPrj+f0Pe/G8adlELORQ5DDeBV0VdwPW7Bn+MF/70IVBkqNDHwa7j8l5fTKpj4ilALT7kxbUh2qtA5XPzl66tJ+ANIRQUf8AciKVkPo9AZXPqPl5PgmQSi4SbLRMX1UGJT8UwbZl/CsbmFrpBx9wrNK3mAVJnG9A1F3pUgibbHO1yn931DqY8KkmVqz1klcsic72KMb/Wz0MBxdKufhd5IUTQj+AiQxys4trMLrao1oxlepfWcXSL9GP/zCb5YBW4qvROS/k1qZqRJ+R6vTVnEX83Q7XxIcxnLzZlQkM8F55AhNxO0odwkcTrrVhLKKd8mmREjxl7wA2E0v5HbqgCuI+CQawK17TTx+w3aJnAfq/VX83w41TZhzCVoaX9LPaa9jibV9m0u1aIoWSA+iBjjXjyAKgXPzWQWeR7PgvIqmgcQ5up5k/zKzOg+r76K3YXRC6rq2fkTFQx7BWJOlC6FFplgMaQtY5wH+KsCFXuNbBWjfKAFiCpGsVWMUs+WdcczXxfN2r/huaQS8ggX92OVrJQIL94ch7d4s5suyfZiswlCOg2N1835XalVGNCrGKJeHWfBeKPg0b5JmiL11BbBjFwY8hY2IKU9b1qkXsQBjBwjaaNg0d+edD1uwXCnYXHTroJRcz0Rq7tcLFprWPyeaDX8w0GKa0FhZrsR/Qt6EQM0Kya1g/BXcVInILA3yrVgsPcVVJAv9HhZb8FcCwbr2tmS8CN2d75tAnQCcALsEcyyWC74RgRBg5yGqPmO8G3kQ3QtKEyTSHNqFDRaraOdrdMScZVJWkY/C9uAgbr5J8joNDTOFDa4g4xCxB549Ms8qRiinu5W9WIlROhFDOCW18eym+dGmR9++enl60tnf0DNVLgyi+p6yCs1Zoz1NM9sJGKok5SmVMo8/scyNxvtGM2zpKi3VGVtpw0jx3qK90bIDB4AZYY8Ke4ft8sw7CSkCEuiM+91aC4mk2o7J4ytzerGyw9SinJPuPDuvrmYTIrQm9xeTWVX5MgEycfh7nIqfRqk6LfgOyYzE8CptGaqedRmMoTt0ac5cpp2oGaeeMN9TiekCO1E0yzIw8/nGZJEJp7MYkiZXXgM6TmSTE0YDCusCDZkmkAOo6ZkrfnNm4E6kG9JUo8889dTHc7SUpy7otTW+zWcTDfC+ETaPoCsx1qFkq2CREc9a0gG+pYT5M6RgHWK7h0KTDw8X4+3fcPp4Dq067t6ZYcryvLIHtTieC4EmZnGyY2LLRfLu7dAcpBmtR/Chp0YujnKXvC1eA7yBhmH5Cr5yL4LQebm3hnlwaPsXkPj442qHQ/tU0dxZ5tqZ71dqhPcEfWn6s9nQgDHgIGasVNBRCsh4a/tdhgdjbEHwRWUmQ1dCNIqSJS76wDrlN1fC7jBfbudRZ/BMyFAFeyMA0tFu6OD0f1iHr0x34UgK1U3oALqFf6TkOnegQaQQk/96jYEPYke4Mt/b3xZCA==" \ No newline at end of file +window.navigationData = "eJylmUt32zYQhf8L107buInbeufK9onqylbspl7kZAGBIwkRCKgAKJvt6X/v4UsECGDAKlvee78hBXLw0Od/MgOvJrvMxA4qnZ1le2K22WVWyLzkoL9vLn+3NQXPzrIdE3l2+e4so5xonV1mRudvmH4DrwaUILWFbhnPFYjs8vMRfX8Hlb5RSqqZzGGoAaIs+gquxy34c7zgv2eBKkOFJgZ+DZf/9nxahTuoloRZeCYMqDWhxwqdw8Wfv7+YhD+A0kyKAX8gipHVMAqdwaX/eD4JThUQA1eUylKYocS6FNQwKfoSjs0tdIGMu1doVqoDpMo0pm8o8rAHRYw93uE6ve8bSn3SkCxTe04qkQN1vosxvtVPQoPA0a1+EnqtZNGM4BNAHq/g2E4utCxXnFG8Sus5uUT6Mf7nE3yxClyVZisV+5vUzEiT8j1em7KIv4KgWx/SXMZyMy415DMpBFDkZoI2lJskTmddK8IEE5skM2LE2HNxIJzlV2pTFiBMBBxyTaC2nSZ+v0HbBO5TufoKNHGztgljLsAo+1vqMe11NKk3H3Kl58WeB+KDiDHu5SPovRQ5qNhs7VlQXsnyAKJk+WmT/BLU2ufVV7G7WIIqmK5n5z+Z5NgrEHOidCWNpJLHkLaMcR7hrxJ07DWyVYzyBytAljGKrWKUerasOx4Iw2j7M7zumYI8wsX9WCUrJcOLN8fhLd7spkvoTq7XQUinofG6OT/sjQ4DehVD1KtjGow3Ch7tm+TDvpnaIpiRC0NewxqUsudNi9SLOICTKpLmpMKiv72YetyC4U7D4gu9CUYXepOI1V0uFq01LH5PjB5+4SDFtaCwO6iiP0EvYoBmxaS3EP4qjuoEBPZGuRYM9rGEEvK5GS/rLZhrwWBdO1sQUWF359smQCcAJ8CeQB1AzcVaBkGDnIbo2ZaITeRDdC0ozJBIc2oUNFquop2t0xJxTRXbRz8L24CBuvknyOg0NM41NriDjELkDkT0yzyqGKKe7pb1YiVE6EUM8Kyn9fuAD8O6T2WqfTd9jjI//PLT2/fnzraDgTBLJjb1m1TqMWOsp3lSQwx1lNKUUhtQn/Y5MVGaZ0lRr5mm7W8aRo71FO9WKgqPgDJDnhT39+tFGHYUUoQFMdR7HZqLyaTezAjnK0J3Xn6QUpR7IqR3983FZFKG3uT2aiq7JBWXJB+Hu8up9HGQot+C75jMTACn0poZ7MkoYmBT+TRHTtMO7ADqVvicTkgR2vmrWeeHn88zJIlcvsyk0GUBMaTnSDIN4TD00gg2ZJpADqOmZK1p05sGOpBvSVIrQf1lWoeztBTnWT9JugNzS6iRynvTRnKKdlPsjcUYjs8bYXxsbp+S1m+ODiVbBYmOOuCQDHRBJyiccwvrqN87uZh4wr8a702HI8xVaGt68c4Ol4znkY2yxfFcCJISIQWjhC/mi5sPQHJQd1CFsGEnhm7O2+diJV+DvEHGIblOPrLvQpA5kJwzETxv7zU0Pt5N2/HQZnoUd/bSdtbbSjvBLdHPuj9ECgEcAwZqxk4HEa2EhL+2e3Z0NMYeBFcwzlnwVloFiQp3VWH9FeCvLNzgrt1zo8/gmRCgDvbZgaWjvdbBmH7Hgd6Y70KQpa4bUAH1NuRFqnTvQANIoZd+rRyCHkUP8OU/g3iSWg==" \ No newline at end of file diff --git a/docs/core/assets/search.js b/docs/core/assets/search.js index 8cba9b0f..cc0c6e6b 100644 --- a/docs/core/assets/search.js +++ b/docs/core/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1XV2X2zaS/S/tV29GKOgzbxkncyY760k2mZ19yMnxYUt0m7E+OqLUtidn/vsSACkVChdUUdI+2S0CVUXgAijULYB/POx3n+qHr3/54+FjtV09fG1o/vphW2zKh68fvjkePuz21b+KQ7Xbfrff7/YPrx+O+3XzaLku6rqs/5QW+erDYbNuyrUlmrIP/37dSZ8YOklf7rb1YX9cHvRiX8V1mIrXD8/FvtwesNVnA2g0Pr9fU6Uu1bq70ldo5Y3653K7/JAo9b/epenOklStFcxhpo5ofNJT1F+2y5/K349lfaj7NPmC+3PBK3Qti/X6sVh+7NXDC12hY1M/9Ypvn18hebvsk+ufXiH1ufiy3hWrPtHnItfIL/fve4WH59dIPj72CvaPr5C7L5/75IbHV8n9vV/u79fJrat/pTMME9w+v0ZyfwvX17ZwU/G3cnm4ILstopMfT7r73bKs67flYV8te0djW3JzKnmFtv1x29uv/vF1cr9xc94F4UVb5joNbzRTYlPuilmRLUhv1ru6XL3ZbbdNn2YXeljqLgtWXrJqAcPmZ1710kv+f7ze1S+meqVv90W1rbZPl14tU+4ur9gnW/WquZfAr/z99qVYV6tv9k/HTVMfvy8qdJeXzQpWvSm0PTMDvN/tN0U6EecNOFW4Sjdo4h8aB6DH+Yel7tnIQPKQVhbm977qz2FN631RXuaer5nIHfKSkeH4FcNam2gPP9/lRZgole2tRVdtO7gu3b6jX9vjl0PZr6UrcY30VXFIHUAuvC1wlexjgHe//HOha3Ssi+1Tr/y2wDWyN8XnXtHh+VWSq/5GCc+vkoy2kJHovj1kv2z/T5/stsA1snNbSS7+0l6yX8NLua8vgfFcRqkhWhAPuzf1S6/8w27pS1wn/efm8QW0H3Z1V+gaHR/KYlX2T5+nIto+4BN9/fTX1b7+fvO8TnWcn91nyhfydPM+MzADo3fL3QqMAqmtK3a9nlVZL/fVM55AE3Vx6au1ht4FM4hUeC44RBdNyYxZTE3VlFe0pNAzqCmvb0mh9UNRY3ctbcyiLtuSN+irD8XhqOi6U7lBuvg08Ut1cJ7rbv/rZW1d0Vv0Fc/P5RasDVLXqdzVmlblukQOUQqSttzVmsqtDv2nctdr+v1YrBW4OJW7WtP75qe/lV8UulzJj6Hk1dqeynTzmSgKha7W0YxM1fC9RcdHVYvd2lpNPUVztaWu1lJr+qS+rU9gzDpV0he5Vmg57H4ql7u9YtZpJreu5A3acs5dqu2Sh3dZW7MxP6I9pdR1KnfDfKqb5U7lrp979ruNtsdc2dv7zIc3/ur9oH+6hlK1Z7UKntNLW2OQp8Zc6b838Kyfd1vnhGEvIylxF7caS1U516nJAymejO5LdE+vXtakPyK20f14l4Y7CVK1lbclt8Uvi/q4B+P3rIIVGS7/UG3QFuAs/VRAJVuu2d9tm/mr1/qmUHkqNFzHpth/7Gub8PgKuaFRLze7utVj8G2q2gUf/lnt1j1B7VzBe4E0L1wLXPweGbDtuhj4QFt4vftY8vuxBHN4vxVdnftYkJv3+m24NP0prFBkHfXb0J97pGkHPhT2u8NuuVtn8M+f3gf0iUQd0iMz8au0JAF+E/7wLi+SCFS9R2RjBhNVzRdRheKq3jZeMaswSDdvwn80i83umGlC/vAuTZgIVDVhZCN+jf+py73LwWsqVMswBD4/V/tyhV+sv/hdXlWhQvXyF95s0Cyjsal/rtFbM5lGiaRtBdZQ1fbQrNfFss25PBXobX0u9s/F8uPu/XsksH3UL4q316NO1qtzOdw+nU0Zi10ezg/PjNXkerqHvVYrmNKszCF5mt5Kda5mXqUyOalPXcS55TVdzt7sU8IzFvM6LiYu9qngyYt5FRdzGPtV/K5ScSGdsU9FFB7K67ic2dirRNUbF5McL6iIvMFeNZfzHYUqPurf7FblEunxD/RzlAj2QEGXIj3BFl3MHCu4EDBPFEQN0eV3/eD5Hziqk0IDpsNL6wyW/UrWy72ZtD6Xl1E+Hp8GqO/K36i2enI+oVtK/Vr8zeNuD9GdsSJU903hqhdt9bsY9WZ9rBv9//Pssl0G9Hpr1DJUP56q32rU9nH3+cd9+b76PMQWV+u5q3WjCZvi84/V9umH45Auaio9N5V2xzt0TCPLhXN96W8Oh3KT8Urypuy76sW5+o1GRRkwl43ozYfRK935VO5/7J2qIdp33p06dPVuNuO75YfdIP1lqHCz4p+K7Wq3yazrWe17VutGE56b2gN0t8VvVVquCjfpD1F8rnKr8mYcf+/0vRTrIQY01apztVuNGLZCPN9lRThNGwM08zr3Uv9tuS6+/LXB8Loc4iuc6q9c/Q+n+vcy6z+rZja9yqDfupr3NeUf//Xz9dYcehIehhvk4kD/W1RXIceRKp9C3ZvNqXfrlyFz5bnGjarrZuDzAOFl1ecaN6o+hBjcANXnGreqXg9547tA7rD7WG6HKG3L36j2WA8a+m3xG5U2+Hjc1UPwfK5xo2o3IH/Y/qXa14c3gxcFV3m3fe8q37I68A3qt+X7ZvNTrpAV3TP9dnRf5gIMkaxXp3LY+JNRw+cjqad/GgKK4sZpFjyspXmgb5ZlsV2W0Ok5C3p1KpQz1dmC7fzPTwe3CUYK2kd6W3/7BPuPy3kVymA7O1tyrvfHErZoJL8tdJWCuoKBiEh+KKMVz1v6bQ2lNz/rW7jZ0hd9Ql61BbKJPNpUayRbkWXdE8xdw747Ce9KDBZdV3ACOgkOz4eLzQc8z6IvhDpj8VHw8Ld6B1fMk+y2wGDBLc95oa27MoPF13FiIGyVixmB+QHi8swywt2jAdNmJjTLBaly+fNhyzSLP6dnQBJ/dnzK9P2cLm32fhb3cd5+To0ubV+ZQp9TosugV2bP5ztHkzyvSfvOaVBkfWsyvnt6/FrxUbJ3Tr4m11uV551TsFakeWtSvLNYvb79RW5yToMuNTkz7f29ONRnlxvpikvoJ8Fq+x6GSIG8V23ZTNJqbGKmsZbrzMYI6esK36wQTiNZjfnZRKdy5S5f0GrsCt+i8P36WEPvHCnsCt+isJmtfvZhEK3SpkLdVbhFcVW/GdSfVX2XHq3q7kINveLVucYtqp+Pj+tK37vn4ndQ+ras6+JJPVzbWptTrVtM6A1qI+2XI9paxT6ZR6+2K34HpW+LLdwB9SjehCq3Kfeu/sDebmvdqbcP+gY/3NrYzi+F6zVS1xW+VSH2l3Mae9xmpcrjo9tPPKq7k1cYqpg7Kn8rv+RiRd0zvXOSi+ZEkvrDOSeDhsVzYg19AR2ggDfIj2FSxEvl6aE+ZalnPYilXVwKzpb1Wt6TWBSX0HdrTyAJiLwYUxKGDg0vIZX9kSadQp/G8G0zRVfb+LzIBd2+3iqqdzbjUK/+o6r/o9o2/VYdvGNzjVk/bPVt4SvstqI9rjKEw+u/3UmU1ffnw/aJMXEJ/RD5xWeRdPV+VYoOqbwXD/8Ls/MO8o/ldpVxGJH2psbzqcatqsM9j9hNzilndW5U/1O5LKuXQdr35yq3KK8PO5gQjLS2ZYeqYwj+6ey09UySaam7TJQZsRcnS2B0Pp+tdQkHGdBU25yr3cGIXH5CjwG9aQl65dvd2yPMZ8yp3u42x3wqo15x4wKuIZ+XU9xVuF1xA/jyCa4Ned2nOreq1yyZOTOuXjYHmpdbOnvtGrR89hoEJqDLk8//w8RzzaRz43AbPtSudQmRwn6XUKewJ+UHqbyU76NUqh9Udx1QdxhM9xlI/YMoBDK/z4TBz0+HHZp458IzVSbxRQh9JSvg3maG5gjNddUUfYfJbqmUF75VIXS6cgrzXpdGoT+3oFPXFb1aWQh2vGtUwZkw0RiXv1btU3V4t9xtNtjrkUqj0ler1GD/1VOe/LmsomdFkXourSYKZTscwE007Xoit5fV/FYeGuenLDYaXbzwtQrXK5WqUOxaJY3//E5ebtqjLC5+rdLtbruEsUqprit4raJchr7U05uar1Dj7lpQ6WkLXqso0GrKOZ8XvlFh7mBRRmXvwaLLSg/r+l3xUlTr4nGtUisr3KJ4yFIuyt+itilSvYfeEVJ6Kn2tSnnbcI++S5cOQ2Wpz1W/+VBsn/ratSsxwPdardQCX3WF+97iZGQ2x8ulBqlVnosPVBo1X47A8g+G5H78+Uvm9OhZkjul2Xtde7Amq+Jt5q6BSEPvTQO9Cpr9keYlmmI3vEVTW/EaTalB7xF16fExd4tF+2hIOni4IOKSsFesYMbi1qq8p3BRR9+V8xfEx/db5RT032h1QUW93n26qKEtdJWCnh1/pOPSVj9VI9DTm2nKnw/AUTbVJpF3KXEqMnBo2lSqrT9pSqPsqTy8zaJXaGvKXkCxRl0PHwRVXmKDtGr7uCCs+CITpFTdxwNBzRdZIKXin/N5+VDvpRx9jdq+zLRU6cW8NJ3Kvqw0pPRiTppG7XHbm1yS6o0rDFPMJrl/5KfS9tE9TkxxUZfOTHUWZexd1z2R+fPTIVYrJL1a5g/3MJOyKv5S4R1WquZ91bO1Uqgq8U48UVT27MR1atTv1JS98a3c+fX6Q/Gx9GcwNUpPNd63Na5VnUmWkvr6sqVUSrSt2RQd3pjRCHJngHPZZKeHAwPz2YPIscBXUeHMC5zsw/a7q/1+LPBFHN0zvfW5Kz0iSf03eZwMyqjInZaOVfQekgYqaLSYmcn5jseoRw9fnstwXeGFBJ9YxhtPJrgLf36OkyuDPPl4QCsHt8tVVQl91VZ4bivgVknMzW0XGkUqrW3BwdrSdmzckEwTnp7oWw/aH8u5ZPrZnj6r2e1XGeuTEtcGkfoFXggiIUuVkaQLei9FkgZohr2WUXuh9/p0yl78tvGCA2UGu1A+1vff6ajJRXGvLpxKSUzUtyDW19t8Pdpk2/1lt1+Wp+vGYPuhIjeN5KzA/reCpubf7L++fQtf5/T7jTiI5VwCwNkafTsJDb2Ng+TLFnlbHJZywfS/DVox39ZPb2RgsJV1fjJI4t+L7U72kv9tmJQd8AfCj4Pk/CgoyyCo/XWQpBNWc95FWuCmcZUR1w8cYKTijfpf5y7jC04QF0ZZfnZQt93whlO0mk8f+lnmRHaao6cDEfZSNe3xl20is/19kLTAGfmj/7B/k+f6Hi6j+wT6xL3qv1EgtVHfxxmFvb3cpy9pv/Xu05tmF3rclJkGTAoM3k/oJL66GPRNTc2NTXbfc7/Ovjuf9fpQv2UU9ndcn8ak5w7FujyfScOdh8rcNF/nJV54NWht79vB17lkfyKHxVZlRLIVmpYYpoGdt5Gi2SP9EZ5t+flwSdCrtlCmsblJZy32bPR3m+fDeVJ/KfaVyxWp/+R/7zWVCfGzXg2khAd6nDl/Z7ev/gU+pASF+vjUqUL/5NtWe/fOwzNjQKAvzvDU2BBIjOWpzj3MGGbAPVV3bMowEzpO5a6mfL/1X977Zv/UzIPbg8aOKlQp2ir3M+KH7sNVA6w4fezqfma0pN4AI1pa7w4m5L9diA3gnxK6g/qLn1rDVjyfqr101e5hDPzYVcaCtuwd1MIPU2Gt7c0Id1AKP+WElbYJHHdQqvzwEjbDxeaLqHIZKl9nmM1FIc7aL0ci4vm92O62jWnrt9+//a5XnGNfQ9FN1ZM8Gir0N+l3nwuWDgCVlW2R65V8Hz7MULD7jaCm9gsMRc/VRhl107My+XWl98etX3vqPz0qPtTEBR2r9Qp/TorJTAppxS95d4dPz/6N0ZRnFbigWs2+bHbh37vvSSDZ56cDBK7qS82SFtKKXzUvuK62JRDaPdKLEjfsclGKC3YjUfw+Wi7n0nW0TMiHov7fulskgLDouVqoOD3CxIUnWkG/hetX+3pVFtGK3lTrdYVMDA+0YrZRVPUsZXsxssqFfAyXkvS9Z1JGK7xGu72z3Fq742MiDx2T3mdwWkgr3q2K7r+OmP6021+c73rLa5V+6sgcoOD0DAn79fVDI6v8/PD1H6es/K8f6Cv71aIp+b4q16um4C8P3ZmK3cY5/M3/Vrul9/0ffm2L/bN0H0J0hUPpP40eXv8yej0ZfTWa2F9/ff1LV9k/8D90Ms6/+Iqm+cu8tqOvJotxVNEkFU1UkZq/6PV4+tV0Po8qUlKRooq2+cu+nky+MlMTVbRJRRtVHOdMHScVx1HFSfPXGJk6SSpOoorT5q8JatVpUnEaVZw1f02RxllScRZVnDd/zVDjzJOK86hig6Bf5kjjIqm4iAHg8LBAL2lS7BgBHo8eiDsD8BMDyDhYGAMrpxgyMYiMg4YhWDnFkYmBZDySLGotk2LJxGAyDiIGwsmkeDIxoIyDiZm8HlPTwaJyiikTg8o4qJgpQodJcWViYBkHFwOhZVJsmRhcxkHGzGHlFF8mBhg5zJgFqkwpwihGGDnMEEQYpQgjMUVRbsYgMEnFACMHGYLopBRgFAOMslMVpfiiGF/kEEMQ2ZTii2J80TSrOIUXxfAiBxiyUHEKL4rhRfOs4hRdFKOLHF6a/RYCSIouitFlHV4ITtI2RZeN0WWzq59NwWVjcFm/AE6h4hRdVqyBNqsYrIIxuKzDC8GRbFN02RhddpJVnILLxuCy09w6alNw2Rhc1oMLziA2BZeNwWUdXgjOIDZFl43RZR1e7AhWTtFlY3SNHV6sQZXHKbrGMbrGDjAWjuRxCq9xDK+xA4yFftI4hdc4htfY5vyPcQqvsfCyHGDsGFoNHK0YXuNJzg0Zp/Aax/AaO8RYOJLHKb7GMb7GDjEWro3jFF/jGF9jhxg7g5pTfI1jfI09viCyxym+xjG+Jh5fENmTFF+TGF+T7Ow1SeE1ieE1cYAZw1ExSeE1ieE1cYgZw1ExSfE1ifE1cYgZ02u7+Go0ncWVU3xNhCfvXXm4Rk2AMx8DbOLnL4jsSQqwSQywiYPMGKJzkgJsEgNs4iAzbgbk+Cszm8SVU4BNYoBNHGTGcL6fpACbxACbOsiM53APkwJsGgNs6jAzhnuDaYqwaYywqcPMBHpu0xRh0xhhU4eZCUTYNEXYNEbY1GFmQrByirBpjLCpw8wEImyaImwq9ot+wwgRNgVbxhhhU4eZCd5upgibxgibOsxMoDcyTRE2jRE2dZiZwPlvmiJsGiNs5t17uJmapQibxQibOcxM4OQ5SxE2ixE2o+y0PUsRNosRNvMIg9iepQibxQibOcxMIbZnKcJmMcJmDjNTiO1ZirBZjLCZw8wUYnuWImwmohI+LAGxPQOBiRhhs6yHP0sBNosBNvP7R7jtnaUAm8UAm2cDFPMUX/MYX/PsEjlP4TWP4TV3gJnCbck8hdc8htfce2ATWDmF1zyG19zDCzoz8xRe8xhecw8vHENK4TWP4TX38ILjcZ7Cax7Da+7hhXsqhddcBL6y8JqD0FcMr7kDzAw6M/MUXvMYXguHmBnc6C9SfC1ifC1MFtiLFGCLGGCLbAh1keJrEeNr4RAzg3uLRYqvRYyvRTY8sUjhtYjhtXCAmcE5ZJHCaxHDa5ENTyxSdC1idC0cXmZwOC5SdC1idC18XBWurYsUXgsRWl1krQbBVRld9fCCC3N4Fldnv7X18wH6EQixjkSMdZTFWHgkq4so68jDDC6x4ZmsLwKtIweeGdwQhmeyvoi1jiY99UG0dSTCrSOHoRncX4Vnsr6IuI6814/Vg5DrSMRcR94rw60Hgq4jEXUdOSzBbXx4JKsL6PlgfS46D6CXBPc99HCAHob3BfZCgB/H6FGEX4b4Q4wfh+lRkF9G+UOYH/ceivPLQH+I9ONgPQr1y1i/D9/P4bJkULRfhvt9BB97mQYF/GXE3wfx8Q7MoJi/DPr7OP4cOqoGhf1F3N/4UH5m8gCRfyNC/8ZH8+fQ1zUg+G9E9N/4iP4chtAMIACMYACMD+rP4YpjAAdgBAlgfGB/Dn1AA3gAI4gA42P7c8z3ACrACC7A+Pj+HFM+gA4wgg8wPsSPI4EGMAJGUALGh/nnmDUCrIARtIDxkf45nrwBMWAEM2B8sH+Bxx/gBowgB4wP+C/w/Af4ASMIAuNj/guMX0ARGMERGB/3X2D8AprACJ7A+ND/AvcfYAqMoAqMD/8v8PIF2AIj6ALjKYAFxi9gDIygDIxnARYYv4A0MII1MJ4IWGD8Ad7ACOLAeC5ggfEHqAMjuAMzDusvnoABfWAEf2DGgV7HMzCgEIzgEIynBRqnDgUeDaARjOARjOcGGq8OWwAwKMgE4/mBxq3DAhDZLkDoSYLGr8ONCFAoWAXjiYLGscMWABgKZsF4sqBx7bAAgEPBLhhPGDTOHX4FAETBMBhPGjTuHbYAIFGwDGbSh0RANBjBNJhANWR8ScA2GEE3mElI9sCTKWAcjKAcjGcRjMGzKWAdjKAdjGcSGh8RCwBIFNSD8WxC4yTiV0CpHwKJnlFovEQsACBRUBDGswomkwECWAgjaAjjmQWTyQIBTIQRVIQJXAQkbwwgI4xgI4wnGBpHE/rkgJAwgpEw0wBEPBQAKWEEK2E80ZDLwAE4FMSEmYbEI+xVAG7CCHLCeL7BEJ7UAT9hBEFhPOdgCI8EwFEYQVIYzzsYwiMB8BRGEBXGcw+YhTOAqjCCqzCefsBEnAFshRF0hfEMBObiDCAsjGAsjCchMB1nAGdhBGlhPA+BSTUDaAsjeAvjqQjMqxnAXBhBXZjAXeD2B+SFEeyF8YQEpqkM4C+MIDCM5yQwU2UAhWEEh2E8LYHJKgNYDCNoDOOZCcxXGUBkGMFkGM9OYO7HADLDCDbDBDoDZywZQGgYwWgYz1IYwltDwGoYQWuYwGsQXgkAtWEEt2HmITaD2xDQG0bwG2Ye5kE8CADFYQTHYeZhHsQzOaA5jOA5jKcuDM7sMYDqMILrMJ6+MBb7JIDuMILvMJ7CMDjDxwDKwwjOwwTSw+KRDHgPI4gP47kMYzESAfdhBPlhPJ+R2eMB+sMI/sMEAsRiJAMKxAgOxHhew+DMHQN4ECOIELMIUULs0wAuxAgyxAQ2BGfwGECIGMGImEUAIp5PACliBCtiPNORWY8AMWIEM2I82WFwNo8B5IgR7IjxhIfBGT0GECRGMCQmUCQZ3xiwJEbQJDQKjiEEIgGehARPQoEnGUOviABTQoIpoRHlxyIBroQEV0Ke+zBj6FYRIEtIkCU0ymdGESBLSJAlNAobFOhcE2BLSLAl5NmPZgeOBYAEYkGX0CgAcYIFgCRiQZjQKAARzgYEKBMSlAl5DsTgbCkCpAkJ0oQCaYKdOwKsCQnWhAJrgr07ArQJCdqEAm2C4/YEeBMSvAkF3gRnTxEgTkgQJxSIE5xBRYA5IcGckGdCMkgGzAkJ5oTaYxJ4KAHqhAR1QuGoxATnlAPuhAR3QuG4BPZxCZAnJMgTCkcmJhjJgD0heWoiHJuYYCSjgxPy5ASZntGMDk8kpyeoZzTDExQCiBSACFdWQqco5DEK6pkR0UkKeZSCJj29iE5TyOMU4TxFZkpFRyrkmQoKwUMYgSV0rEKeqwgHK3K9CIAoD1fQoq8XARAFjUI2ABEf4AE8CgkehcIpiyl0TwgQKSSIFPLEiMEpcwSYFBJMCoXjFjhtjgCVQoJKIU+NmCmekACXQoJLoXDuAmeTESBTSJAp5MkRgzPKCLApJNgUsuH0GJ6QAJ1Cgk4hT49kBiOgU0jQKeTpEYMz0wjwKST4FAp8Cs5OI8CnkOBTKPApU4xkwKeQ4FMo8Ck404wAn0KCT6HAp8wwkgGfQoJPoXGe0yNAp5CgUyjQKTM8EgCdQoJOoUCnzPBIAHQKCTqFAp2CE7kI0Ckk6BQKdMoMjwRAp5CgUyjQKTM8EgCdQoJOoUCnzDCSAZ1Cgk4hz47goy4E2BQSbAoFNmWGRwJgU0iwKRTYlBl2UgGbQoJNocCmzLGTCtgUEmwKTXo2zQTYFBJsCgU2BaenEGBTSLApFNgUnF9CgE0hwaZQYFNwggkBNoUEm0KTcKwWDwVAp5CgUyjQKTjFhACdQoJOoUCn4BwTAnQKCTqFPD2CI2AE6BQSdAp5dgRn3xJgU0iwKRTYFJzkQoBNIcGmUGBTMg4aYFNIsCkU2BSc5kKATSHBppBnRzKhWAJ0Cgk6hTw9kgnFEuBTSPApNA04xOsiIFRIECo069s0A0aFBKNCs75NM6BUSFAqNOvbNANOhQSnQp4jMThbiACpQoJUoVkII2IoA1aFBKtCszAj4rEEaBUStAp5msQs8IwIeBUSvArN+jYrgFghQaxQOCOCWX4CzAoJZoUCs4JzpggwKySYFQrMCk6aIsCskGBWKDArCzwnA2aFBLNCgVlZ4DkZMCskmBUKzArOmyLArJBgVigwKzhxigCzQoJZocCs4MwpAswKCWaFArOCU6cIMCskmBXyRAmN8GgEzAoJZoU8UUI4dYoAs0KCWSFPlNAIIxEwKySYFQrMCh4KgFkhwaxQYFZw4hMBZoUEs0LheAnO3SLArJBgVsgTJYRztwgwKySYFfJECY3wUADMCglmhTxRQqPpazv+arYgIQAAUTAr5JkSwrlbBKgVEtQKLWZ9FgAgCmqFFgGIeCwBaoUEtUKBWsm46oBaIUGt2ECtYFfdAmrFCmrFjky+DSygVqygVmw4hILz1yygVqygVuwoXMYygndPAGrFCmrFjsZ9rwBuzRDcivVUCRk4n1jArVjBrdjRtM8CcH+G4Fasp0oIJ8BZwK1Ywa1YT5VkGxHcoyG4FTta9L0CuEtDcCvWUyVkIMVmAbdiBbdiPVVCBs5IFnArVnAr1lMlhGlGC7gVK7gVawIS4eJsAbdiBbdiPVUC48kWMCtWMCvWBBzi218AtWIFtWJNHw4BtWIFtWJNwCG+ygVQK1ZQK9b04RBQK1ZQK9b04RBQK1ZQK5YCDvF8BKgVK6gVG26lwkmAFlArVlAr1jMlhJMALaBWrKBWbLieCicBWkCtWEGtWOqbEQG3YgW3Ytt7qvBNfoBbsYJbsZ4qIZxFZQG3YgW3YgO3gi8kAtSKFdSKpXlfEwAgCmrFhourcBqXBdSKlXdXhcurMhag66vk/VWeKcGZIxZdYSXvsAqXWOE8MouusUrusQo4hMELC++yEjgMt1llboZC91nJC61swCEezOhSK3mrlSdKKHNDFLrZSl5t5YkS7F6hu63k5VbhdqtMfYBCeb+Vp0nwTXUW3XAlaBXrWRJ84ZwFrIoVrIr1JAm+N84CUsUKUsV6jiRzgxvgVKzgVKynSDIXsQFKxQpKxXqKBN+KYQGlYgWlYj1Dgq89sIBRsYJRsZ4gwUf5LSBUrCBUrOdH8Il8C/gUK/gUO86fjbeATrGCTrGeHcEn3C1gU6xgU+ykzysEbIoVbIqdBADixRTQKVbQKdazI2TxYgroFCvoFOvZEcK3tVlAp1hBp9hJ/py8BWyKFWyK9eQI4TxQC9gUK9gUOwmTIF7KAJtiBZtiJ+H2SLySADbFCjbFenKEcB6nBWyKFWyK9eQI4TxOC9gUK9gUG9gUfE7LAjbFCjbFTntOSVnApljBpthpACJeywCdYgWdYj09gjl6C+gUK+gU69kRwpmkFtApVtAp1rMjhDNJLaBTrKBTrGdHcjs0QKdYQadYz44QTgS1gE6xgk6xnh3JuTSATrGCTrHTcJ8png0AnWIFnWI9O0JjPJoBnWIFnWI9O0JjPJoBndL95i8ofyn3h3L1fbio/JdfHt4td6vy4fUfD+/ay8sbeHg97hrzZib8+o9///t8WXnzF7uv3D1zmt6tytN3yCJRhomyKlHtZ5nPMlxs7CSEgpTXDy4MphL37D7NF9k0P4trRriv5o7wqKS5O/Kr0xX6zMjxjBk5UtrmpLUfvakjE1mrhbqNTxoMHc10ov2nWc8SXZz4bN9C16tOyDtnX7UXXTJlEHHpXGpp/lMAsWEMIi5KrxVVnj8DcJY2Y73gLqsJbUYjtVT5YbazaPbGLWicp6+Re/rkC7Nzzu0cd33bdfZkrBNcbpdRL7M+1g02L2H3HKOPjzd3Y45KkPvQTLZbnOdytmwy0Yn8cigju4g1mrLpl0UE2wUfBHMdKpbF+2pdxmLGXIwO/cvTJ5yZoPmUCZoOExQ1zYRNaR2YdENpWWyX5TqyyrARacIC0My3M7U8/u0njgHDMaB9WSYtfDHmo/sKERc74WJ1aF02S2DcoxPeo7rZ0QlJocF7dK4bhMt11fz5rhJTLJ8XrdKkVtJzLIm4pCE2PVfbp7r9mCmfsjn+F1qBuzpuKmJNZbSjyH+3MhbDp/x5h9apcn7A38Hk78pe1XTzvnIoOOGo+birsFAidn10H8aL+5XPZla3ZLRyjs+r4gBtm3PblO8p/Udm16Rd0oy2QxpZSy5szjrA3aClE+L7891xv67jFuPAtbplqA8c0RDtwKHz/c5id92XfdlL8xnYqAXWh/1xKR1TJinUbL0N6oZK93e7cNC8fZET2junJPw7aX+fteXm7d/z9u9FK2/Rygt+uluQlEPcf/OtCl+E4/P8lM/zSjS577z1eCUzLlIH9mbcxD6F4fOPXki8NjKPSzm5nD9Ex1+Ie0gTHW5W5ePxKQIfWy4M6TqtGbRiEuA7hFnn4Bpdt52/jMfamc9M7gadAMqpzolrP5DHu43PKx2mrdIHa8SVcQ+OWQ9OW2nuXge9tPht+bRHk7b9XOaGTiDejPNtZecmTpVwq7oPn6FFg8N3pHxp9/XleCHnHTzvtvla+3Ifc2Zmcjeo22mNlS16DF9FjjZbrIuUk34ZvlzObeJNp1yRmj2bGGwTZsqUusGma7lme1/Ey+SErRlTnXcHGpu1tqUBUmJoRY1sdct/+0VYLoUbowxpvW8qN3uNuGWYnKnO4XrfOFwfYpzz7fVcKWW3b7YbZX4I8j2bHelw1AjdFHFDRY69Tsh+t3GG7aP5i29eZjprnsrIlAlzIqedEznT4agR1fy5r+LwwZQ5EMpmbwRtis/xxMyDkVNdGzViXBCymZ7ikCH3tU0bVHKp81qZ+92yrOV+iK9E7ux5K1W3sDVSm84sqxchdBJtg04hAd1IaoTW5f5F7F74yHZXt2glhW/Dx5tubp0WI9XhnStRxaKmPBCgnG+edrEIHgJQxqk+FNtV/aH4WL6v9rV4Ob5bVOL2QxFPW2xYT7uFf6YWlUzuY9ZIwRN3joRuLDTyPtXPp68M80maL4VTHbRCSChaldmgGitN6r5RzN6QTfSd92Um7U6GuoCtu9cg/Oe0ibInx1QHww870d1T3t1KtyJ8mNzvc1xXFY+7OLw1Z3OpIV3L8o+d807iIWYlo9OKiiIPkXljbp5SptsfPu+b8RJNz/MJF6VDeCNKRpoN34CTMqhYbd/HEwFxY5TR5mq7qZ+ELZHfqptPqu1Lsa5Wxf7J/566Zzx01I5gl7gzQPbuudxjpoS/t+24krESdkF4O8unonkQgDrRSsjUIHrIg9Lu/q92YVMip+62HbFMvoGezzqZuiWuqt1gqZ93WzknzdgwWShhAJhKTlQqQwS/Nctu4xcUm3im4u6Lch/1W70Tmz7uBSjnzN8+xVOm4dObkjprZEiK1F0+y+SobcnHlziRbpX7BUFvuFNabPnXYaiRkRIT3C2c62a0ZPvDaaZu3Vfiel3Eo4QPPCV41kW8Vk7YZDCdd+boXm29EmDmzaOcCBsZaCfG95pKtn5T7CNikDsByj5vdnIxF0x8WNhue+GS63TionWVT2njbk+h9NEaUe+eiy/rXSHSOrjXrlweGlmbZstTPIn1mu8WSckSNLIcv7U7xr4SZ6VI2/afT3vz4nBwUZ7YweEhYlJb96kQmxPux5Mylropi/q4j0OzbEpRzgStlHg/zaxRUqabZntZRfQOZ++UFNamWq+reMzxNCM7VXZaHH7kjq0WjHW87hsOHaWj1shAmQHuDBQbvLr5qJH1YRX7DIY7emaq7Owgp9o8Rxs0vj/TziLCl2UN1C4f4y5HR5ky5atzo1g7jbuNGunafltsd2Lu5p5rF+awymbbFof6HH6Oe4HvcGbKN43GCV8QdNXLz3FoL8qeUQ61rfRGOCzNidtVpuI5aYnTxYeuURLOnaCM18UXYCXtvN35XLzDvliKvSknJUhp3i7JvuNTgzsyqBNTLj9EO0oeezTK+Ox2tznGEUzuxZFp/SZSLnXb3XYZO5YzvlVWbsWaLU6xXe021b8iWTyOZ6xuiuG7pWS7yDMkZqdtrg77p/1tNAyZhXNdBzT+BYgvcH9FSRo3gtLYAPcIlLu552IvgjpMRqiz6DgkJZn3XNSRXQs+qLtEAncDgk5Y4iuyQdjG4MYdgWd0vflcrgo3W0RW8v2eMsMKxPGJz+5W6d61cnyCVcyl8tG50L7cPsoujfI3Qx1l+KmRtKnqukH9S7Vb4/AO3yrNT4NKN324961cPOqliHwLnphplClqzyLKybMyjW19AVKO9pZLCQ6qSBria7dW2CEOBc74GNO2VRskTzqAC1t02TljJe6Oj3FWBU80age9UWLl+Nj44fFqzr1o02UEkXYWCQIFT8SXc1LmELWS2q1ibCFHiXIKb8WBRC3Dc91opAPu78fyGBnFl9BFxwMqg2Fe2AofSeBElDId+LSPjUYWD2Tbk9eng8lJos/BcUTXOu5hnjJrlJTbSShOUOU5WdbohttJ5G/VQWRacgrOKBk9Ie4Qp1jwqJ5RZnz10v/cuVfOUid5h2pTylgDDxcaJQ21LxNmlmcGGSUdty/j9GXuS5xyW3TzQCNqLTYwvOG70z80OvF4Wvj9Hu/veGN1Juomvfb4TzxH8fG20L6ql5MuFmyCWpyynrQI8TI3xTZuRJ6KaZRniZgsNI/yzBpS+nStSCiOR82VlGJ3EKvZBB7KpzhNy3BuWnmcqNmX7NYv8eoz4uvtuDt8poymtBudGHl8dCgphlYOXB35TKfM7N+XL9VL44HGx7o4sWOVWaT7gxgHfLAqfeH9MQ69RKcDtBJ8MCDeaHFLtGLgUR0OJSWS0uwZ4o6b7Q662VGXfaB81SBYnjzhUwYp/cpWkgzPGU5aknLaCbJCMmC61HHEW2UyQ5CYEPQT3hXKeEMQFfcoP8JolORRK2fZOERP8rwrn7yU2Yq1yJ5jsJ92CfgzZfMLOHDAGmWCdF2J0Dhf0brcY1KmM9ciTBTxve0+b9bNpcrgWr3efYoHOM+7UU6kTog7dtH8CpHKCThlfK0Rsy7PUWQklceolUFAJzU+48e5U1LOaM6YGPicEjCdd0HK853pu/ENy+RE6HY92x0oscrzxs4ziN+ZRyq1OAHegOGji7Rz+GEv80R4irRRsla12L9H8fhuCLRjwip5EJRSycdr2+6zdh5ZnOIEp7Ndyjnq+CiPGhuesEXKwxyNHHe+4TGeFHiyhVHmx7SSkpMShof9Scn/cGHAJ6Uod0kZbsxdN0ARb3o6oqU8LOE2fIL2drdCs0m1y/DtcsOoS8Em5SLSqki3I6y/F523MtabHa+8PFtXedhWbMTNKFpM1DLeFS9FtS4eRZYNfz3SvlYjDV6yMONztHLz7IQ5V+d9PGPxexFIud1oRKGtFY+ak5LLPOyW9UtE27JXU3qFyc0Rhh9DNso4r5eSXo7BU1HmA+zpYSH54q/MjT7s0pMUfCerTOI/7NLFhm/susNzyvR9T4qump1xtU34MMPPlNGoc+y6k9KkZEy9it1WxGp4mjmNupnodG5V6fscvjzHbNeID6uT07LomIxRdxawy/K23WvZUbsC2m5JtKb7pUsAt6fjs8r9xHGLlzNOoZEyqe1Yi9g5J5PM+PSqOhg5aQzfjgr6/OwmqXRS5/Gg0SnjV9c/To2r7DjETw34e4YU59mUx2ScdMlOEl/rSMkB+LTkcFKg+W8cv+cXLCi7ysuIkyuZLz3rgojKSzeaGf9RXq/AYW6Uu3i3I5WnHBmExt34Vt7e4YLKu60/0gJYBcPvQTDKVeBTDSQRnymsZpb89fXDc/Vc+gPUX//y67///X9DXSSs"; \ No newline at end of file +window.searchData = "eJy1nV2X2zaShv9L+7Y3IxSoD/ou42TOZGc9ySazMxc+OT5sid2mLZEdkmrbk5P/vgcASQHFF1RR0lwlbgFVRbDwVU8B/P2urj43d6/f/X73qSh3d68Vbe7vyuyQ372++/bYfqjq4t9ZW1Tl93Vd1Xf3d8d6f/f6brvPmiZv/jQu8s2H9rC/u+9L3L2+u/vjvpe+VDRI31Zl09bHbSsX+yqs46m4v3vO6rxssdUnA2iRnJ7vOaubXKy7L32BVr9R/5yX2w8jpfavN2m6kyRRazlzPFMXlAx6suZruf05/+2YN20zpckWrE8FL9C1zfb7h2z7aVKPX+gCHYfmaVJ89/sFksvtlFz76wVSn7Ov+yrbTYk+FblEfl4/Tgp3v18i+fgwKdj+fIHcOn+ekut+vkjub9Nyf7tMblP8ezzCeIK73y+RPN3CzaUt3BwfPubb9ozsrohMfjjo1tU2b5q3eVsX28ne2JU8DCUv0FYfy8n3an++TO63Zsw7Izzrylym4Y1kSKyP5QWjojchvdlXTb57U5Vlvo1P9LDUTSasuGTRBIbNjzzquYf8TzzexQ8meqTv6qwoi/Lp3KNFyt3kEadkix419hD4kX8oX7J9sfu2fjoe8rLFz4sK3eRho4JFTwptj4wAj1V9yMYDcdyAocJFukET//ic1xOLf1jqlo0MJM9pZWb+5KP+4ua0yQf1y9zyMUdy5zxkYDh+RDfXjrS7P9/kQTxRIts7iy7advi6ZPuOaW0PX9t8Wktf4hLpu6wdLwB94V2Bi2QfnXtPyz8VukTHPiufJuV3BS6Rfci+TIp2v18kuZhuFPf7RZLRFjIQPbWHnJZt/zMluytwiezYVtIXf24vOa3hJa+bc854KiPUEEyIbfWmeZmU31ZbW+Iy6b+0dXHG29uq6QtdouNDnu3y6eFzKCJ9B/5A3zz9dVc3Pxye92Mdp99uM+QzebJx3zMw4kbvt9UO9AKurS92uZ5d3mzr4hkPoCN1YemLtbq3C0YQrvBUcI4uWpFKvJiaqCkvaEmmZ1ZTXt6STOuHrMHLtXFjZk3elbxCX9Nm7VHw6oZys3T5w8S7ojUr16r+9by2vug1+rLn57wEcwPXNZS7WNMu3+doQTR2kq7cxZryUub9Q7nLNf12zPYCvxjKXazpsSh3f8u/CnSZkp9cyYu1PeXjzedIkSt0sY4PmWQszK56jk+iFru2tfZZI2iurtTFWhrJO2mueycwZj1WMhW5Fmhpq5/zbVULRp22qvuSV2iLLe7G2s6t8M5re8n2R7Sn5LqGcleMp7JRbih3+dhTVwfpGzNlr39nNrzxV7sO+qdpKFF7Fju3cnrpasxaqXlL6b9XP+fNc1WaRRheZYxK3GRZjaWKFtdjk2cinojuc7hnUq/XpD8h2mj+eJOGGwSJ2sraEtvi51lzrEH/PanwisyX3xYHtAU4SR8KiGTzOfv7sq2LSeuf8jYfCs3XccjqT1Nt436+QK5r1PPNLm710PkORWOCD/8sqv1EUDtW8FZOGhcudVz8HBFnq/oY+Exb/Hq3seS3Yw7G8Gkr+jq3sSA27k3bcG74E1ghyDqatmE690jSDn5XqKu22lb7iP/7v97G6UcSZZ4emIkfpYME+En8H2/yICOBoucIbIz4RNH4k6hAcdGUVe1XmKXbb8J/FIe8Okaa0P/xJk04EihqwsBG/Bj/1+S1ycHLy7bYui7w5bmo8x1+sOniN3lUgQrRw595slmjjMSm6bFGbs1yFSSSdhW8hirKNq8fs22XczkUmGx9X+yfs+2n6vERCex+mhblt9eDTNarUzncPr1NEYtNHs6Pzx7V9PX0P05aLSClUZlz8jStleJczbhKYXLSlLqAucU1nc/enFLiZyzGdZxNXJxS4ScvxlWczWGcVvGbSMWZdMYpFUF4KK7jfGbjpBLR2zib5HhGRbAanFRzPt+RqfJ7/Ztql2+RHvuDfIxiwR4o6Fykx9kii5ljBWcC5iMFQUP0+V0/Wv4De/Wo0Izh8Nw8g2W/4vViT8atj+Vl5A/Hpxnq+/JXqi2ezJrQTKV2Lv72oaqhd0escNVtU5jqWVf9Jka92R+bNq//79lku8x4651RW1f9OFS/1qjyofryU50/Fl/m2GJqPfe1rjThkH35qSiffjzOeUWH7MtzUT5Vxxu8mEP2xYRzbelv2zY/RFYlcVPqvnp2qn6lUUEGzHkjJvNh5Eorm8r9j9qomqO9ssuptq93tRnfbz9Us/TnrsLVin/Oyl11iMzrUe21V+tKE56zZk7Ld8WvVZrvMjPoz1F8qnKt8qJ8+sHoe8n2cwwoyqfiVO1aI+bNEM83mRGGYWOGZr/OrdR/l++zr3/Nyt0+n7NWGOrvTP0PQ/1bmfXfRdteZtDHvuZtTfnH//xyuTXtRMLDfINMHOhfWXGR5xio8tnVvdqcptq/zBkrTzWuVN3k9YsfIDyv+lTjStWti8HNUH2qca3q/ZwnvonLtdWnvJyjtCt/pdpjM6vrd8WvVPqS1w9VM8efTzWuVG065I/lX4q6ad/MnhRM5ap8NJWvmR38Dep3+WNe1/kOWdH/Jt+O1nkswBDIejWUw8YPRs0fj7ie6WEIKAobZ599xVr22Vd5s2yzcpvDRc9J0KuhUMxUYwu2878/t2YTjBR0P8lt/fgZvj9fzitXBtvZ2xJben/KYYsG8rtCFyloChiICOS7MlLxfku/baD0t82TvIV3WZtNCXnVFYgm8khTrZFsQZb1RDB3D9/dILwvMVt0U8ABaBDsfp8vNh7wPIk+E+oMxQfBw49NBWfMQXZXYLbgjnOeaeu+zGzxTZgYCFvlbEZgvIOYPLOIcPPTjGEzEpr1BYly+eNhy3EWf0zPjCT+aP/k6fsxXdLs/ajfh3n7MTWytH1hCn1MiSyDXpg9H385kuR5Sdp3TIMg61uS8T3xxi8VHyR7x+RLcr1Fed4xBZI0b0mKd9RXL29/lpsc0yBLTY4Me3/P2ua05Ea6whLyQbAoH2GIFMh71ZWNJK2GJkYaa7uPbIyQvr7w1QrhMBLVGB9NZCp35vIFqca+8DUKH/fHBq7OkcK+8DUKn/L2FxsGkSp9ytumr3CN4qJ5M+t9Fs1N3mjR9BdqyBXvTjWuUf18fNgX8rd7Kn4DpW/zpsmexN21q3UYal1jwmRQG2k/H9GWKrbJPHK1ffEbKH2blXAHNKH44Kpcp9wu9We+7a7Wjd52K2/w9trGNutSOF8jdX3haxXi9XJM48SyWajy+GD2Ew/i1+lXmKvYX6j8Lf8aixX1v8kXJ7FoTiBpOpwzGDQvnhNqmAroAAV+g/zkBkU8VQ4/ylOWJuaDUNrZqeBk2aTlE4lFYQn5a50IJAGRZ2NKzNC54SWkcjrSJFNo0xi+y5u2KMPzImd023q7oN7JjLbZ/VfR/FdRfsjrorULm0vM+rGUt4WtUJWsPS4yxHev/zUnUXY/nA7bj4wJS8i7yDubRfLD6MT/tGiXynv28D8zO75A/ikvd5EFI9L+lLfPQ41rVbt7HvEyOabcq3Ol+p/zbV68zNJen6pco7xpK5gQjLR2Zeeq8zz459OibWKQHJe6yUAZEXt2sARGx/PZuiXhLAMO2ZfDqdoNjIjlJ0wYMJmWIFdeVm+PMJ8xprqsDsd4KqNccdNme8jzYor7CtcrrrM2f4JzQ1z3UOda9ZIpM2bGxdPmTPNiU+ekXbOmz0mDwAB0fvD5Dww8lww6V3a3+V3t0iUhUji9JJQpnEj5QSrP5fsIlco71U071A0602060nQncoHMHyJh8NOv8w5NvDfhmSKS+MKEvuIV8Nv2DI0BzX2Rl+17DLu5Ur/wtQrhoiumML7qkii05xZk6vqiFytzwY73xxqny400huUvVftUtO+31eGAVz1caVD6YpUS33/1FIc/51VMzChcz7nZRKCswgHckaZqInJ7Xs3HvG3aOs8OEl1+4UsV7nciVa7YpUoO2Zf3/HLTCWVh8UuVllW5hbFKrq4veKmiWIY+1zOZmi9QY+5aEOnpCl6qyGE14ZjvF75SYexgUUTl5MGi80rbffM+e8mKffawF6nlFa5RPGcqZ+WvUfuS18UjXB0hpUPpS1Xy24Yn9J27dBgqG6+5mjcfsvJpql37EjPWXrudWOCrvvDUUwxGRnO8TGqQWOWp+EylQfPFAJb9YU7ux5+/Rk6PniSZU5qT17U7a6Iq3kbuGgg0TN40MKmgOraSh6iO7RVPUR1bwWNUx3bWcwSv9PgQu8Wi+2lOOri7IOKcsFdewYjFnVXxlcJZHVNXzp8RH95vFVMwfaPVGRXNvvp8VkNX6CIFEzv+QMe5rf5YDfOeyUxT//cZfhRNtRnJO5c4FRg4N21qrG06aUqi7Clv30a9l2l7ytszXixRN8GDoMpzNEiqdooFYcVnSZBQ9RQHgprPUiCh4l/ieflQ77kcfYnaqcy0sdKzeWkylVNZaUjp2Zw0idpjOZlcMtYbVpin2Bvk/hEfSrufbnFiyhd17sxUb1HE3n0zEZk//TrHaoGkV9v44R7PpKiKvxR4hzVW81hMbK0EqnK8Ex8pyid24jI14mfK6/bKpzLn15sP2afcnsGUKB1qPHY1LlUdSZbi+qaypURKpK35Kf86vzGDHmTOAMeyyYYfZwbmoweRQ4GvgsKRBxjsw/abq/1+ilzE0f8mtz52pUcgafomj8GgiIrYaelQxeQhaaDCb5J/eSmEE6MjKDbvNU9eWhWTPnFt1RRmQs8UjRZELrKKmjS+yupGpkgvt4padvZ6q5saev7CqzOGTlx5dStDpy/BitsXuQbrRmZNX4wVtSpyNdbtjBJdljVl3vR1WTcyNBbnjho2inTfypBzl2rFLYpeq3Uz02IXbU3YNLpq62bGTF6+NWERvn7rRmbFZu+oPaOJ/FaGTFzSFTcGXdN1K4POXNwVNyp2ddetDJs7I46Y4Y0MmTwLFbUGH4i6tUnnLv06b1702q9bmxq/COy8keAqsP+MeZHLwaQW8ruabm3k1IVh522EV4bdzMTopT0Tho3v77mRORMXi0XNQVeL3cicCQ4RNQcxiVuZgzOq4qb8Z9w6GguIGzIKCNzIlNjWO2rJaBd+I0MmLi+L2oKuL7uRObILzaKWnbnS7FZGNn/JzCcnYPwtblvzONTCwZRpE2iRrtXy9O2MIFLWfn3uPgNx5uBUKOONTdI0+8VfwkOrTh7/eUb0yuEsU1Uk9FVX4bmrgBtoZG6so399zkVau4KztY3bsWrySBMOv8hbD9ofyjln+smeKau9IEvE+lGJS5NzpgWeSc5BlgozdM7oPZehM0MzfGsRtWfe3pRO/ha/K5purIOvkP8sf3/DFR5nxb06c9vHyER5C2J9k803oY233V+qepsPkSnYfqjIVT05KnD6qaCp8Sf7n+/ewscZ/n6lH4RyzjnAyRp5OzENk42D5PMWeZu1Wz5h2r/NmjHfNk9veMJVJ+v0yyyJf8/Kir8l+7d5UiqwHnB/nCXnJ5YK7gR1f50lafDV2OpiXOCqfhURN+04wEjBE00/zk36FxwgzvSy+Oggbrv5DSdoNXss6xd+1rTXHPw608Neipe8/ks5ktn9fZY0l4tr6Rh8v6Pf5W84D+5pnBL3avqmxrGN8nccUTj5lqf0jdpvX31+U5XN8ZBHGnBUYPZ+Qibx1dlkurGpsb7pfUdrWufUt7Tk+tB7iyicfnFTGkdvrs32+WnriV8eKnPVeB2XeObRoLWTTwcf55z9IzlezhrPZeiEjkvM0+DdY8JFez+dkenl7pX5l/acoFddoUhj+ybFLf9X80u1/ZS3PC7idLJfJ+3XJ6HfH57bk6iXrC7M6Z7mT/bvUiF2PG2AFPeD3IPNSqqqi3+DT19DoTa7ZKgwPax31d6/t44fMcAlnJ4cX2KDSzvdDnVuYcY8A26pus9/nWdCnwV7U1N+KF+yfbH7tn46HvKyldhRuCpZV+V2RvzYf2p8hhXD58lvZ0aXhj3DiC4R+wYm+F9/lhjgf/z5BuqjHxCftuJ5qPbSV7uFMfDz5BELurI3UAs/JY61dndZ3kAp/Pg2VtrhrRsoFX4qG5thOE4WVM5d5csM07H4xkn7+RhHOL5nZVUW22z/9oe330+KM/nyruihmDju6ypMN+n3XzKP9EBleVfkciU/uMzCzKNdUFOXQJhNXEYdUbc6KePfw348lnbuaf70IPi0ti/oWOx3+APgnsxRIan4rf+6/2qvYvibl1h+UoELitXUedbmP5jURyT79OsMgbvmXLOMC0nF7/Jsty/KHAjtf5KLYt9E8kUJPokUiPK/IOTLOfcBIU/Ih6z5V9NPEkBY8LtYKLvvwxPnfpEK+ug+mDP1VnkRqehDsd8XyET3g1RMGcRrT1LKszFbX8gnd43s1HOOykiFN2gfeZLbSPeSnsi2P/swZfC4kFS8mRXN/5qjBJ+r+ux4N1leqvRzc8oR4AqG35CwX+/vinKXf7l7/ftwj8LrO/pGf5Pe3d89Fvl+19y9ftcnE5v7esy0cX+3q7Z27X/3a1fsn7nZEZvCrvSfFnf37xb3y8U3m6X69df7d31l+4P9Qy/j9BdbUd3dv1P3Wn2jUwoqqlFFFVSku/t3dJ+sv0k266AijSpSUFHf3b/T98vlN+kyDSrqUUUdVExipiajiklQcXl3/y5Bpi5HFZdBxdXd/bslatXVqOIqqLi+u3+3QhrXo4rroOLm7v7dGjXOZlRxE1RM7+7fbZDGdFQxDR3A+EOKHlKNfUcx57HeA/1OAf8JHUgZt1AKVh77kAqdSBnXUAQrj/1IhY6krCdp1Fpq7EsqdCZlXERBd1Jjf1KhQynjJmp5n9A36YpVHvuUCp1KGVdRK+QdauxXKnQsZdxFQddSY99SoXMp4zJqAyuP/UuFDkbGZ1SKKtPYwyj0MDI+Q9DDaOxhxIYoio0YBAap0MHIuAxB76Sxg1HoYBQdqmjsXxT6FxmPIejZNPYvCv2LVlHFY/ei0L3IOAxpqHjsXhS6F22iisfeRaF3kfEXSqCDjL2LQu/Sxl8IDtJ67F069C4dnf302Ll06FzaToArqHjsXZrNgTqqGMyCoXNp4y8Ee7Iee5cOvUsvo4rHzqVD59Kr2Dyqx86lQ+fS1rngCKLHzqVD59LGXwiOIHrsXTr0Lm38RS9g5bF36dC7EuMvWqHKydi7ktC7EuMwGvbkZOxeSeheiXEYDddJydi9ktC9Eh1bfyRj90rYKss4jIavOQELrdC9kmVsGZKM3SsJ3SsxHqNhT07G/pWE/pUYj9FwbkzG/pWE/pUYj9FrqHnsX0noX4n1L+jZydi/ktC/lta/oGcvx/61DP1rGR29lmP3WobutTQOk8BesRy71zJ0r6XxmAT2iuXYv5ahfy2NxyR0r9NvNqtlWHnsX0u2krdLeThHLcFiPnSwpR2/Elh57GDL0MGWxmUS6J3LsYMtQwdbGpdJVvdJ8k261mHlsYMtQwdbGpdJ4Hi/HDvYMnSwlXGZZAP3MGMHW4UOtjI+k8C9wWrsYavQw1bGZ5Zw5bYae9gq9LCV8Zkl9LDV2MNWoYetjM8sCVYee9gq9LCV8Zkl9LDV2MNWbL9oN4zQw1Zgyxh62Mr4zBJvN8cetgo9bGV8ZglXI6uxh61CD1sZn1nC8W819rBV6GHrRXQztR572Dr0sLXxmSUcPNdjD1uHHram6LC9HnvYOvSwtfUw6NvrsYetQw9bG59ZQd9ejz1sHXrY2vjMCvr2euxh69DD1sZnVtC312MPW7OohA1LQN9eg8BE6GHr6Ap/PXawdehg6zS67V2PHWwdOtgmGqDYjP1rE/rXJjpFbsbutQnda2McZgW3JZuxe21C99rYFdgSVh671yZ0r411L7iY2YzdaxO618a6F44hjd1rE7rXxroX7I+bsXttQvfaWPfCb2rsXhsW+Iq61waEvkL32hiHWcPFzGbsXpvQvVLjMWu40U/H/pWG/pWqqGOnYwdLQwdLoyHUdOxfaehfqfGYNdxbpGP/SkP/SqPhiXTsXmnoXqlxmDUcQ9Kxe6Whe6XR8EQ69q409K7U+Msadsd07F1p6F2pjavCuTUdu1fKQqtp1GoQXOXRVetecGJ2v4XVvb919eMB+gUIsS5YjHUR9TH3E6/OoqwL62ZrXB/EWRcs0LowzrOGG0L3G6/PYq2L5UR9EG1dsHDrwvjQGu6v3G+8Pou4LtaxkIf7iVdnMdfFJgYQ3E+8Oou6LtLYNt79xKsz17PB+lh0HrjeKLiv4gF6GN5nvucC/DhGjyL8PMTvYvw4TI+C/DzK78L8+O2hOD8P9LtIPw7Wo1A/j/Xb8P0GTksKRft5uN9G8PEqU6GAP4/42yA+3oEpFPPnQX8bx9/AhapCYX8W91c2lB8ZPEDkX7HQv7LR/A32HxD8Vyz6r2xEfwOnKgUAgGIEQNmg/gbu5hRgAIpBAGUD+xvc/QEHUAwEKBvb3+CpA6AAxViAsvH9DdwfKYADFOMByob4cSRQASKgGBJQNsy/gbEHBaiAYlhA2Uj/BqNJAAYUIwPKBvtT7P+ADSgGB5QN+KcKPj/gA4oBAmVj/mmEUQL/Y4xA2bh/iv0XYALFOIGyof8Uvz9AChRDBcqG/9Mlrg/8j+ECZRFAiv0XEAPFkIGyFCDF/guggWLUQFkQkGL/A9xAMXCgLAtIsf8BdKAYO1CJm38XmDMDB2T8QCUOr+MZGCAExRiCslhALQhOYQAjKMYRlGUDaoF9ELAExWCCsnxALfAgCniCYkBBWUigFtgLAVRQjCooCwrUArshAAuKkQVlYYFaYD8EcEExuqAsMFAL7IgAMChGGJSFBmqBl7EAMihGGdRyyhMBaFCMNCiHGiJrSUAbFMMNaumSPbArA+KgGHJQliIoBSNfClAHxbCDsiRBKUjUFCAPiqEHZWmCUtiVAX1QDD8oSxSUwgsCQCAUQxDKUgUVyQABFEIxDKEsWVCRLBBAIhRDEcqxCAhvFIARitEIZQGDUnhDB4CEYkRCrZwj4q4AoIRiVEJZ0BDLwAF+yMCEWrnEI7yqB2xCMTihLG9QhJfVgE8oBiiUZQ6KcE8AjEIxSKEsd1CEewLgFIqBCmXZA6ZwCqAKxViFsvgBgzgFaIViuEJZAoFZnALAQjFioSyEwDhOAWahGLRQlkNgqKYAtlCMWyiLIjBXU4BcKIYulGMXuP0BvFCMXigLJDCmUoBfKAYwlGUSmFQpgDAUYxjKYgkMqxSgGIphDGXJBOZVCoAMxUiGsnQCsx8FYIZiNEM5nIEzlhQAGooRDWUphSKIBxSgGophDeW4BuGZAKANxdiG2rjYDG5DgDcU4xtq48ZB3AkA4lCMcaiNGwfxSA4wh2KcQ1l0oXBmjwKoQzHWoSy+UBqvSQDuUIx3KIswFM7wUQB5KMY8lIMeGvdkwD0UAx/KsgylsScC9qEY/FCWZ0T2eAB/KMY/lAMgGnsyQCCKMRBluYbCmTsKcBDFQIhKXZQQr2kAC1EMhihHQ3AGjwJARDEiolLniHg8AVBEMSqiLOmIzEcAjChGRpSFHQpn8ygARxSjI8oCD4UzehQAJIoREuUQSWRtDCiJYpiEFov42pgAJyHGSchxkgSuigiQEmKkhBYU74sEWAkxVkKWfagELqsIwBJisIQW8cwoArCEGCyhxTK+uCZAS4jRErL0QyUwYkQAlxDDJbRwjgiHEwLAhBgwoYVzRDgaEEAmxJAJWQaicLYUAWhCDJqQgyZ4cUeAmhCjJuSoCV7dEcAmxLAJOWyC4/YEuAkxbkKOm+DsKQLghBg4IQdOcAYVAXJCjJyQJSERTwbkhBg5oe6YBO5KAJ0QQyfkjkoscU45YCfE2Am54xJ4jUsAnhCDJ+SOTCyxJwN6QvzUhDs2scSejA5O8JMTpCZ6Mzo8MTo9QRO9GZ6gYI5IzhHhzEroFAU/RkETIyI6ScGPUtBy4i2i0xT8OIU7TxEZUtGRCn6mgtbxCCyhYxX8XIU7WBF7i8AR+eEKSqfeInBEhlFIO0fEB3gARyHGUcidsljB5QkBkEIMpJAFIwqnzBEgKcRICrnjFjhtjgBKIYZSyKIRtcIDEmApxFgKuXMXOJuMAEwhBlPIwhGFM8oI0BRiNIW0Oz2GBySAU4jhFLJ4JNIZAU4hhlPI4hGFM9MI8BRiPIUcT8HZaQR4CjGeQo6nrLAnA55CjKeQ4yk404wATyHGU8jxlDX2ZMBTiPEUSuJMjwBOIYZTyOGUNe4JAKcQwynkcMoa9wSAU4jhFHI4BSdyEcApxHAKOZyyxj0B4BRiOIUcTlnjngBwCjGcQg6nrLEnA5xCDKeQpSP4qAsBmkKMppCjKWvcEwBNIUZTyNGUNV6kAppCjKaQoykbvEgFNIUYTaHlxKaZAE0hRlPI0RScnkKAphCjKeRoygZ3BUBTiNEUcjRlg7sCoCnEaAot3bFa3BUATiGGU8jhlA3uCgCnEMMp5HDKBncFgFOI4RSyeARHwAjgFGI4hSwdwdm3BGgKMZpCjqZscFcENIUYTSFHUyILNEBTiNEUcjRlg/sioCnEaApZOhIJxRLAKcRwClk8EgnFEuApxHgKrZwf4nkRABViQIXWU5tmQFSIERVaT22aAVIhhlRoPbVpBkyFGFMhy0hUiqd2AFWIQRVaJ/FoMgGqQoyq0HoZjyYTwCrEsApZTKJSPCICrkKMq9B6arMCwAoxsELujAim/ATICjGyQo6spHhMBmSFGFkhR1ZSPCYDskKMrJAjKykekwFZIUZWyJGVFI/JgKwQIyvkyEqKx2RAVoiRFXJkJcVjIiArxMgKObKS4iENkBViZIUcWUnxgALICjGyQhaU0AL3RkBWiJEVsqCEFrgvALJCjKyQBSW0wJ4IyAoxskKOrMDsQQJkhRhZIUdWcOITAbJCjKyQO16ywF0BkBViZIXSePI/AbBCDKyQ5SQ4f5cAVyHGVchiEpy/SwCrEMMqZDEJzt8lgFWIYRWylATn7xKgKsSoCllIgvN3CUAVYlCFLCPB+bsEmAoxpqItIsH5uxogFc2QiraEBOfvakBUNCMq2gISnL+rAVDRDKhoy0dw/q4GPEUznqItH8E9UAOeohlP0RaP4PxdDXCKZjhFWzqC83c1oCma0RRt4Qje62sAUzSDKdqyEcx2NWApmrEUbdEIzt/VAKVohlK0u1kK+q8GJEUzkqItGMH5uxqAFM1AirZcBOfvasBRNOMo2nEUnDWpAUfRjKNox1Fw/q4GHEUzjqLVxOZEA5CiGUjRDqTg/F0NQIpmIEU7kILzdzUAKZqBFO1ACp7GNAApmoEU7UAKzt/VAKRoBlK0Ayk4f1cDkKIZSNHdHVRwSagBSNEMpGhyMzFcEmoAUjQDKdpdRrWAS0INQIpmIEVbMEILfGkQICmakRTtbqVabO718ptlyhsReCIjKdqCEcI5zBqQFM1IinbXU8UsAJ7ISIq2YIQUvgkIkBTNSIp2JAUHzTQgKZpfVeVICg6aaXRbFb+uSquJNkBXVvE7q9ylVQouizW6tmp0b5W7Fg2eKNXw7irmie72qtgjAE/kF1hZMEI4j1ujS6z4LVZ6NWUB8ER+lZW7y0rh8QDdZsWvs3L3WcUaEXgiv9JKp1OPADyRoRRtyQjhdBsNUIpmKEVbMkI4FV0DlKIZStGJ80Q8KgOUohlK0YnzRHylGEApmqEUbdEIJLsakBTNSIpOnB/iAQ2QFM1Iik6m/BCQFM1IirZghHAqugYkRTOSopMpPwQkRTOSopMpPwQkRTOSoi0YIZwMrwFJ0YykaEtGCCfDa4BSNEMp2pIRwsnwGqAUzVCKtmSEcDKwBihFM5Sil1MjIkApmqEUvXQ3RuLlBUApmqEUbckI4WxiDVCKZihFO5SCdyqApGhGUvRyM9UEwBEZSdEWjFDkUkRAUjQjKdqCkZgFgKRoRlK0uysL5nBqAFI0Ayl65fwQD2eApGhGUvTK+SFenQCUohlK0ZaMUOSmRIBSNEMp2pIRwrclaoBSNEMp2pIR0rgzA5SiGUrRK3eFKe7MAKVohlK0JSN4fQZAimYgRa/S6G21GnAUzTiKXi+il85qgFE0wyh6raJ3x2pAUTSjKNpCEXwFrAYQRTOIoi0TiVzGChiKZgxFWyQSuVMVIBTNEIp2V2tF7AcOyAiKdrdr4S4EAIpmAEVbHoJv5dGAn2jGT7TFIfhyHQ3wiWb4RFsagq+50YCeaEZP9CZ+WY0G8EQzeKI3amJZCeCJZvBEb5wD4skUwBPN4Im2LITweQQN4Ilm8ERv3CiI50IATzSDJ3oTv7JGA3aiGTvRGzcI4qkMsBPN2Il27ASfZ9CAnWjGTrRjJ/hWUg3YiWbsRDt2gs8jaMBONGMn2rIQwucRNIAnmsET3cETHDsE8EQzeKLdsRR84FkDeKIZPNEWhhA+j6ABPdGMnug0nvuqAT3RjJ5oS0MIH0fQAJ9ohk+0xSGU4L4I+Ilm/ESn64ktHgAomgEUbYEIJbgzA4KiGUHRaTqxJgIIRTOEkiycI+J7hQFDSRhDSSwTIXweIQEQJWEQJXEXeCX4fmFAUfq/2W+NvOR1m+9+cN8ceffu7v222uV397/fve++Q5Is+q+a/H63pLvXv//xx+m7I69//8P79Ij5zWh6v8uHj5UGopQnSotEZbud+bzRSYYJrg1CyEm5vzNxNJG4Z/P93sCmzUncauGqmdO4ImnmczfF8DUcz8hk7Rm5ENpmpHXfr2sCE71W6x531Rm6WMtE2++3nySaQPMg04SSpULeG/uKmr2SleciJjNbLM1+1Sc0zHMRA9ylorwv+pykrb23YO6dc21G3Vs2MFoqnn9s9aTDe/RF/3JkZg+fcfMM3vgGJ/1L7t/6ZikTnJfb4HVr72XLJVTPoRv6Hc/cgicSZD4eF30/ZglzsmwjFPm1zQO7yGs0LesP2yzw31T7TrcQings9nkoJvHFyLrBNtvvjSMEgjYrT9BqnqCgabxePowYMufcZuU23wdWKa9rKjcT3N+Z9CyhPP97jr4PJL4PyIaiQJr7Ctwn82VBX6zvFRuhW+R1G77Rpf9GhbbldTt2Df+NbmSdcLsv8rJ9X7Cx1h8gtdCkTtJzKIl8SXNsei7Kp6b79Lk/dq/8SUUqsGrCpiJPipL2Ivst6lCMP/Zvem9dCR0Bf9vaf1av7VQ/7svmeSscNV/qN59sMNzuj+Zjt+F79UczncyRc3zeZS2yTS1824Rdni8kPbuW3ZSmpC+k2uVbX9jGM8jciikTYt/n+2O9b8IW8wduLZtkp5wj6KKdc6yF08ogtrLL58DQjT8CK6G3VWXT1sctX6F6klzNbrVBfVfp/91NHO6l39/p3tv7B+ve5LL7+7ort+n+ven+nXby0k5emvYTkrCL2++4Fu4rr/447/ca4YLRfrs1virxdzwm7iARucvacE2h/PFnKbPLdL7AkuDZZCKGj8v6D+S9bRMHkQl6OD4FzudNF6of8yiVjS+7nI8G/p5h3a90lWw0OH321mvwhb92TnpvTWXe1X391n9//gDTO7cJ4QjF5eGrTLxXueqkmUub5NLCp/XHP3NwquuT0neLt+f+RrNfLwo3M7ui/6opmj18/xOuWXZ1VpThjO6/4I3uhyehfUZcUT5NDdv+eqjfcgkjAbtjnfHm1P4wIhtF8sNzy5axnlGGZYmklLyzLT1TVtR3NlnL5b8ds3C+XHqvcyVb5oHG9pf9wmCQ+1J92D7+3la4mOg+9+5L8cMhwuX5Y1HuPuVfw5bx3tZKNjI+7o/Nh9DP/X32Riilqrd5nU90Qb+dhEucx6o+ZGFD+QslmUs/1tXBGFYH45e/i1nLrHnKA1OW3gOt+tXkWvbqnvI2L9u6COMIK2/jIWz2p7w9ZF/CgdkPTwp3BE95a8KSRRlMuMoPTZo7ZLoNt2yMNzLraps3fGPkz0TmYplOqmyce8rbOt/mxQsTugz2Q0NsQDbUP+Vtk9cvbBvjD59KGPkyko4PH/Mt28b71kl9pGjfmxJFKGrlRwS0bDx+qkIRfixAGLD6kJW75kP2KX8s6oY9nB9qFvrthywctrxuveon/rVY1GhwT7xGWq77hYSsL3zIms/Nc1211bbah2OPPxUKY7cuNhTMyl6nSoQmWSFhSN6zpV99mZtsnd/3kVtzaVG3qer/ooeFqbB5K/a6V/7rFi4riqeyqnO74TGvKnuowjjXxhtL1bABTGV9zgnfZg0L6/nBIKFbdqKCWERgZ+Lb2a8AU1kvtFvH5zp/LIIBe7P0ZfavKZV1y6IcRaOVv0mnpdS2x3CMIN8qYUS6KA/NE7MlWNJKn+kl2xe7rH6yfx+v3Pzw0rpfJstG+k529ZzXmKb4z617niIcsTvh3QQwFh1EJ3vRQsdsQIRR+zGUTR8mEUvsdyShTH+TvVn3MoU9sTHdp3muSj5crb2OI3VtgDV9qrmUDT0f87Zp6zw7hIOYv7JJZO79sanYftBfIAj3IR8/h6OpvyxWS9mr+/i55TzVXDrvyRHbMhGD8tfrwpGYIRBzOttbGYhljOGFv2IUUrrRzshHUf2SQOjX+yzsJX7HEzrPPgun0aU3GKw2vTmyR9vvmDP7zZPI1tH73QFt0vw9sXBleMjqAB766wPhOz9kbciLTXreyZCkH4eFMIbtiPwhLem3GyvZfHHIvrx/zr7uq4zlgPgL+kQs65A3TfbE5mt/I0lCknDIvhgGVh3DZZRPrvoIkjmyLRQ57N+ztjWRoHDt48eTh6B8KhuFD9mXzxnbyfiLfhIGXg951hzrMI7rDTLCsaGTEm6+PWuEoPWQt3URQCGf+QnB16HY74uwF/phUC1cXB7CWKUflZK6ZxOuBJTvTMKl26F5QvkE5MvSwhHq0Dx92IWrCOUv/ZQwGNnJKQ7PwW7OxzZL2RjOV7feQ3UTStKn+Agzrmx13yjvzSf9rm5Y4y5kZpZZWbFhPXDLfukpXIeVWducgtbh6/C3Q2vhIwcdxp8rZNXzLyxy6ge5hSHPki9U/HlPDWhYOLYZaaP1mE+8lHAE7gVFFmT+lCiVWNmcvrbOtmwj66OMgawKSWhZjdL5lJ/sksiWn2WVbz8Eu04/dKko7a2SjV9ldTiGkVB/yUeqe0gi2ZqkrMptuApd+/tq8TPWWbmrDsW/A1l+PFAN28yFWOawxxptMv3ci/WwOZY98rArDnqoZ6oQRVfHFkQl/FWOEEdXx3YcUfBXDcI94HNWs+CQJ8PVSXsoJfS256wJ7Er9/q4HOD28WtnABJaaXsfqOkTSo8FEKDTfZWZECcz1t4tDMGIh8xOACigIbgiDTp0cm8wVJiL58xVJn7IOMlmDXFFXRxjGes7rQ9E0RVW+FNUeh4n8Lddm6GbCxy7Kp8LEtV6yYEXiJ4GqIbtFmOf6zCKqfiqo0n1UsV9TaGHadgdw3EKXpSz5U79UWBsGGdd+P0yEztdF5kevxBeWDklPQtOOD2Eqh5/m1A0MSug9x4d9wYCqvxpXfT4SSUcaJ5DBKT/+T8J5u5PUbUJDC313EQ7znTiQJqb84BEJp7XfjvkxMMqfb/uBlIRhNitsh09G+PRLmIw8bIyDLuaHyPWwaByG/JmibQaQwWz78FX7mbuqP3ehhRuMQTpOmFV+fpewAw4iPxYty/z0SaDS/bAo7DhMbhumfPihRDUwLCVz/Km8BD+Iay6fmCWvLQ45j2v4wUql+0WsknX2Oh+xYz8rVwmBYZ2Hmdb+4mTIvpG23fOebZb8V9GfWKLFQBplE1ad/xbuJf1W602UNpo9shQOaH7nFObgdXLGM4s3mqVDXpa0e1uZh6wMG9Gnk0qY1OfJQoOun/tjvnYzQyQU5wfvhcn0/eGxts7a/ClMJPOTkrUw4lLnTbV/CaeqhT8596FhteyHXSW11G6hQhf0u4kwlNDJgXOqPxoK0wXq/KV4yevH8Eyanxiol0JnblmH8HutkP3XxzDeE5xokEqwEYhwC+dbIhUDjxf58xfJXGqc6EP+2KOHhfcwySSyR3WC+WkZf+wwn5mYIYkHB5UPUUk4VTlZLm8RTH4+5BOerXUSRwkDS/9VCNOAnajwjfrnL1WPa7RwOOsEbj9k5RM/tesPZ+JHDZmd5/+r/vSAcIfRML/wPVcJT9g1BYvQ+3Ncny9Nwihxw0JSAYjutonrfnQVDqrNvvoc9nQ/V0g4ohoh5szI8ZBDl/XDoEvZkrVps31+imEjqX7EQRhVMlLDA4o+1CXh0GaMCXuATyZUv94g+aOyZ/P3O8uBNPdvtj8No6U+2Fbh0tLPxSapn4D1gfJ7F0kH87bmCSz+XKlWwkZj2/+ABvRdoA+dCFEYSgP1+2vX7utuHEmHMMNwME04Rh0f+Dlp5aeU0UrYlMcHcybjIRwU/JNISgiMOkmj0x3Khw4kpHe+MLBKpeDstbTJIpcmUHDcadUvBIQYyOwFGY83tyJ7g2qf19gDPerTxmmI1CuZw3a6xjsV78Wn/fpFCOaMzHAu9lONhWcS2K7d3OrsNUDfosIkh3bfvM9esmKfPbCEIP85Sbg+M9Lg5RFrf9QWbrCNMLMKegzHMP++BxLucdp9g7ZffoSepK+w2jYvAU/2Hk24YBzdiGEu1vbeYT8MCoO+Vtz49g8/fUZ4Nn6QFMGj/qMK10BtNT4Y4m97hWcS2mo8D/mbv/4soDBH1dLaXd60RTmiccrPDaFFv+YbTkMKT0ZbFVXJAjs+YaZFP0gN6djC8zbt1+eQtfnnIvVwrm3Iajid5x0OEfZrkiF6lvR/Sfq/DCcO+yWNFs5zxxLPdD7AIyHJOTYsKu/faqOSIQFr2MXI3o4R6zm64U9fns2wNR7v/SjSYkiTE7ZEk9emskGZn6t64pYUP+02EcIGI51DUvLnQxJiBptT7U5AvGT7EBH4N0gI35mVEWaGerP+ug89CsN7L3n9wO+P8G+hUIPnCrcDZvvKj3F6TtWLI2EUyASnq9Ke2QEEQ/mgVSV9jxQuvj83QCT5Z8YSIeL63EzeOkD+KoKEwdLPzWNm7hwIg5D+XKZJ2IZNU20/5S2S52cCa8lu49f7u+fiObcn5F+/+/WPP/4fVcg7Rg=="; \ No newline at end of file diff --git a/docs/core/classes/AuthorizationError.html b/docs/core/classes/AuthorizationError.html index 5c7b39a7..b21a3981 100644 --- a/docs/core/classes/AuthorizationError.html +++ b/docs/core/classes/AuthorizationError.html @@ -7,11 +7,32 @@ message name stack? -prepareStackTrace? stackTraceLimit

Methods

captureStackTrace parse -

Constructors

  • Parameters

    • message: string
    • Optionaloptions: ErrorOptions

    Returns AuthorizationError

Properties

cause?: unknown
message: string
name: string
stack?: string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

-

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

-
stackTraceLimit: number

Methods

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+prepareStackTrace +

Constructors

  • Parameters

    • message: string
    • Optionaloptions: ErrorOptions

    Returns AuthorizationError

Properties

cause?: unknown
message: string
name: string
stack?: string
stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

+

The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
    + +

    The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

    +

    The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

    +

    The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

    +
    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
diff --git a/docs/core/classes/ClosedConnectionError.html b/docs/core/classes/ClosedConnectionError.html index 49243a66..8a12e26b 100644 --- a/docs/core/classes/ClosedConnectionError.html +++ b/docs/core/classes/ClosedConnectionError.html @@ -1,15 +1,36 @@ ClosedConnectionError | @nats-io/nats-core
@nats-io/nats-core
    Preparing search index...

    Class ClosedConnectionError

    Class representing an error thrown when an operation is attempted on a closed connection.

    This error is intended to signal that a connection-related operation could not be completed because the connection is no longer open or has been terminated.

    -

    Hierarchy

    • Error
      • ClosedConnectionError
    Index

    Constructors

    constructor +

    Hierarchy

    • Error
      • ClosedConnectionError
    Index

    Constructors

    constructor

    Properties

    cause? message name stack? -prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    -

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    -
    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +prepareStackTrace +

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

    +

    The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
      + +

      The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

      +

      The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

      +

      The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

      +
      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
    diff --git a/docs/core/classes/ConnectionError.html b/docs/core/classes/ConnectionError.html index 21f31554..03db27db 100644 --- a/docs/core/classes/ConnectionError.html +++ b/docs/core/classes/ConnectionError.html @@ -2,15 +2,36 @@ Extends the built-in Error class to provide additional context for connection-related issues.

    A human-readable description of the error.

    Optional settings for customizing the error behavior.

    -

    Hierarchy

    Index

    Constructors

    constructor +

    Hierarchy

    • Error
      • ConnectionError
    Index

    Constructors

    constructor

    Properties

    cause? message name stack? -prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    • Parameters

      • message: string
      • Optionaloptions: ErrorOptions

      Returns ConnectionError

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    -

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    -
    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +prepareStackTrace +

    Constructors

    • Parameters

      • message: string
      • Optionaloptions: ErrorOptions

      Returns ConnectionError

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

    +

    The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
      + +

      The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

      +

      The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

      +

      The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

      +
      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
    diff --git a/docs/core/classes/DrainingConnectionError.html b/docs/core/classes/DrainingConnectionError.html index 76a89ff7..584156b1 100644 --- a/docs/core/classes/DrainingConnectionError.html +++ b/docs/core/classes/DrainingConnectionError.html @@ -4,15 +4,36 @@ gracefully closed or when they are transitioning to an inactive state.

    The error message is set to "connection draining" and the error name is overridden to "DrainingConnectionError".

    -

    Hierarchy

    Index

    Constructors

    constructor +

    Hierarchy

    • Error
      • DrainingConnectionError
    Index

    Constructors

    constructor

    Properties

    cause? message name stack? -prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    -

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    -
    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +prepareStackTrace +

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

    +

    The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
      + +

      The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

      +

      The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

      +

      The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

      +
      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
    diff --git a/docs/core/classes/InvalidArgumentError.html b/docs/core/classes/InvalidArgumentError.html index c72c1853..be098b07 100644 --- a/docs/core/classes/InvalidArgumentError.html +++ b/docs/core/classes/InvalidArgumentError.html @@ -1,13 +1,34 @@ -InvalidArgumentError | @nats-io/nats-core
    @nats-io/nats-core
      Preparing search index...

      Class InvalidArgumentError

      Hierarchy

      • Error
        • InvalidArgumentError
      Index

      Constructors

      constructor +InvalidArgumentError | @nats-io/nats-core
      @nats-io/nats-core
        Preparing search index...

        Class InvalidArgumentError

        Hierarchy

        • Error
          • InvalidArgumentError
        Index

        Constructors

        constructor

        Properties

        cause? message name stack? -prepareStackTrace? stackTraceLimit

        Methods

        captureStackTrace format -

        Constructors

        • Parameters

          • message: string
          • Optionaloptions: ErrorOptions

          Returns InvalidArgumentError

        Properties

        cause?: unknown
        message: string
        name: string
        stack?: string
        prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

        Optional override for formatting stack traces

        -

        https://v8.dev/docs/stack-trace-api#customizing-stack-traces

        -
        stackTraceLimit: number

        Methods

        • Create .stack property on a target object

          -

          Parameters

          • targetObject: object
          • OptionalconstructorOpt: Function

          Returns void

        • Parameters

          • property: string | string[]
          • message: string
          • Optionaloptions: ErrorOptions

          Returns InvalidArgumentError

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Methods
        +prepareStackTrace +

        Constructors

        • Parameters

          • message: string
          • Optionaloptions: ErrorOptions

          Returns InvalidArgumentError

        Properties

        cause?: unknown
        message: string
        name: string
        stack?: string
        stackTraceLimit: number

        The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

        +

        The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
          + +

          The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

          +

          The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

          +

          The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

          +
          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

        • Parameters

          • property: string | string[]
          • message: string
          • Optionaloptions: ErrorOptions

          Returns InvalidArgumentError

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Methods
        diff --git a/docs/core/classes/InvalidOperationError.html b/docs/core/classes/InvalidOperationError.html index 2a19b32f..42b8922d 100644 --- a/docs/core/classes/InvalidOperationError.html +++ b/docs/core/classes/InvalidOperationError.html @@ -5,15 +5,36 @@

        InvalidOperationError

        The error message that explains the reason for the error.

        Optional parameter to provide additional error options.

        -

        Hierarchy

        Index

        Constructors

        constructor +

        Hierarchy

        • Error
          • InvalidOperationError
        Index

        Constructors

        constructor

        Properties

        cause? message name stack? -prepareStackTrace? stackTraceLimit

        Methods

        captureStackTrace -

        Constructors

        • Parameters

          • message: string
          • Optionaloptions: ErrorOptions

          Returns InvalidOperationError

        Properties

        cause?: unknown
        message: string
        name: string
        stack?: string
        prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

        Optional override for formatting stack traces

        -

        https://v8.dev/docs/stack-trace-api#customizing-stack-traces

        -
        stackTraceLimit: number

        Methods

        • Create .stack property on a target object

          -

          Parameters

          • targetObject: object
          • OptionalconstructorOpt: Function

          Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Methods
        +prepareStackTrace +

        Constructors

        • Parameters

          • message: string
          • Optionaloptions: ErrorOptions

          Returns InvalidOperationError

        Properties

        cause?: unknown
        message: string
        name: string
        stack?: string
        stackTraceLimit: number

        The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

        +

        The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
          + +

          The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

          +

          The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

          +

          The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

          +
          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
        diff --git a/docs/core/classes/InvalidSubjectError.html b/docs/core/classes/InvalidSubjectError.html index b017bb88..a7a09e01 100644 --- a/docs/core/classes/InvalidSubjectError.html +++ b/docs/core/classes/InvalidSubjectError.html @@ -1,14 +1,35 @@ InvalidSubjectError | @nats-io/nats-core
        @nats-io/nats-core
          Preparing search index...

          Class InvalidSubjectError

          Represents an error that is thrown when an invalid subject is encountered. This class extends the built-in Error object.

          -

          Hierarchy

          • Error
            • InvalidSubjectError
          Index

          Constructors

          constructor +

          Hierarchy

          • Error
            • InvalidSubjectError
          Index

          Constructors

          constructor

          Properties

          cause? message name stack? -prepareStackTrace? stackTraceLimit

          Methods

          captureStackTrace -

          Constructors

          • Parameters

            • subject: string
            • Optionaloptions: ErrorOptions

            Returns InvalidSubjectError

          Properties

          cause?: unknown
          message: string
          name: string
          stack?: string
          prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

          Optional override for formatting stack traces

          -

          https://v8.dev/docs/stack-trace-api#customizing-stack-traces

          -
          stackTraceLimit: number

          Methods

          • Create .stack property on a target object

            -

            Parameters

            • targetObject: object
            • OptionalconstructorOpt: Function

            Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          +prepareStackTrace +

          Constructors

          • Parameters

            • subject: string
            • Optionaloptions: ErrorOptions

            Returns InvalidSubjectError

          Properties

          cause?: unknown
          message: string
          name: string
          stack?: string
          stackTraceLimit: number

          The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

          +

          The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
            + +

            The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

            +

            The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

            +

            The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

            +
            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
          diff --git a/docs/core/classes/NoRespondersError.html b/docs/core/classes/NoRespondersError.html index ad985502..5092a006 100644 --- a/docs/core/classes/NoRespondersError.html +++ b/docs/core/classes/NoRespondersError.html @@ -3,16 +3,37 @@ is typically found as the cause for a RequestError

          The subject for which no responders were found.

          Optional error options.

          -

          Hierarchy

          Index

          Constructors

          constructor +

          Hierarchy

          • Error
            • NoRespondersError
          Index

          Constructors

          constructor

          Properties

          cause? message name stack? subject -prepareStackTrace? stackTraceLimit

          Methods

          captureStackTrace -

          Constructors

          • Parameters

            • subject: string
            • Optionaloptions: ErrorOptions

            Returns NoRespondersError

          Properties

          cause?: unknown
          message: string
          name: string
          stack?: string
          subject: string
          prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

          Optional override for formatting stack traces

          -

          https://v8.dev/docs/stack-trace-api#customizing-stack-traces

          -
          stackTraceLimit: number

          Methods

          • Create .stack property on a target object

            -

            Parameters

            • targetObject: object
            • OptionalconstructorOpt: Function

            Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          +prepareStackTrace +

          Constructors

          • Parameters

            • subject: string
            • Optionaloptions: ErrorOptions

            Returns NoRespondersError

          Properties

          cause?: unknown
          message: string
          name: string
          stack?: string
          subject: string
          stackTraceLimit: number

          The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

          +

          The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
            + +

            The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

            +

            The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

            +

            The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

            +
            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
          diff --git a/docs/core/classes/PermissionViolationError.html b/docs/core/classes/PermissionViolationError.html index 3fcf646c..a872e52e 100644 --- a/docs/core/classes/PermissionViolationError.html +++ b/docs/core/classes/PermissionViolationError.html @@ -2,7 +2,7 @@ It provides information about the operation (either "publish" or "subscription") and the subject used for the operation and the optional queue (if a subscription).

          This error is terminal for a subscription.

          -

          Hierarchy

          Index

          Constructors

          constructor +

          Hierarchy

          • Error
            • PermissionViolationError
          Index

          Constructors

          constructor

          Properties

          cause? message name @@ -10,11 +10,32 @@ queue? stack? subject -prepareStackTrace? stackTraceLimit

          Methods

          captureStackTrace parse -

          Constructors

          • Parameters

            • message: string
            • operation: "publish" | "subscription"
            • subject: string
            • Optionalqueue: string
            • Optionaloptions: ErrorOptions

            Returns PermissionViolationError

          Properties

          cause?: unknown
          message: string
          name: string
          operation: "publish" | "subscription"
          queue?: string
          stack?: string
          subject: string
          prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

          Optional override for formatting stack traces

          -

          https://v8.dev/docs/stack-trace-api#customizing-stack-traces

          -
          stackTraceLimit: number

          Methods

          • Create .stack property on a target object

            -

            Parameters

            • targetObject: object
            • OptionalconstructorOpt: Function

            Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          +prepareStackTrace +

          Constructors

          • Parameters

            • message: string
            • operation: "publish" | "subscription"
            • subject: string
            • Optionalqueue: string
            • Optionaloptions: ErrorOptions

            Returns PermissionViolationError

          Properties

          cause?: unknown
          message: string
          name: string
          operation: "publish" | "subscription"
          queue?: string
          stack?: string
          subject: string
          stackTraceLimit: number

          The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

          +

          The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
            + +

            The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

            +

            The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

            +

            The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

            +
            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
          diff --git a/docs/core/classes/ProtocolError.html b/docs/core/classes/ProtocolError.html index d421d9c7..d3b73fd7 100644 --- a/docs/core/classes/ProtocolError.html +++ b/docs/core/classes/ProtocolError.html @@ -3,15 +3,36 @@ error type called ProtocolError.

          A descriptive message describing the error.

          Optional parameters to include additional details.

          -

          Hierarchy

          Index

          Constructors

          constructor +

          Hierarchy

          • Error
            • ProtocolError
          Index

          Constructors

          constructor

          Properties

          cause? message name stack? -prepareStackTrace? stackTraceLimit

          Methods

          captureStackTrace -

          Constructors

          • Parameters

            • message: string
            • Optionaloptions: ErrorOptions

            Returns ProtocolError

          Properties

          cause?: unknown
          message: string
          name: string
          stack?: string
          prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

          Optional override for formatting stack traces

          -

          https://v8.dev/docs/stack-trace-api#customizing-stack-traces

          -
          stackTraceLimit: number

          Methods

          • Create .stack property on a target object

            -

            Parameters

            • targetObject: object
            • OptionalconstructorOpt: Function

            Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          +prepareStackTrace +

          Constructors

          • Parameters

            • message: string
            • Optionaloptions: ErrorOptions

            Returns ProtocolError

          Properties

          cause?: unknown
          message: string
          name: string
          stack?: string
          stackTraceLimit: number

          The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

          +

          The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
            + +

            The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

            +

            The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

            +

            The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

            +
            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
          diff --git a/docs/core/classes/RequestError.html b/docs/core/classes/RequestError.html index 44920b0e..f5003695 100644 --- a/docs/core/classes/RequestError.html +++ b/docs/core/classes/RequestError.html @@ -1,15 +1,36 @@ RequestError | @nats-io/nats-core
          @nats-io/nats-core
            Preparing search index...

            Class RequestError

            Class representing an error that occurs during an request operation (such as TimeoutError, or NoRespondersError, or some other error).

            -

            Hierarchy

            • Error
              • RequestError
            Index

            Constructors

            constructor +

            Hierarchy

            • Error
              • RequestError
            Index

            Constructors

            constructor

            Properties

            cause? message name stack? -prepareStackTrace? stackTraceLimit

            Methods

            isNoResponders captureStackTrace -

            Constructors

            • Parameters

              • message: string = ""
              • Optionaloptions: ErrorOptions

              Returns RequestError

            Properties

            cause?: unknown
            message: string
            name: string
            stack?: string
            prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

            Optional override for formatting stack traces

            -

            https://v8.dev/docs/stack-trace-api#customizing-stack-traces

            -
            stackTraceLimit: number

            Methods

            • Returns boolean

            • Create .stack property on a target object

              -

              Parameters

              • targetObject: object
              • OptionalconstructorOpt: Function

              Returns void

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            Methods
            +prepareStackTrace +

            Constructors

            • Parameters

              • message: string = ""
              • Optionaloptions: ErrorOptions

              Returns RequestError

            Properties

            cause?: unknown
            message: string
            name: string
            stack?: string
            stackTraceLimit: number

            The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

            +

            The default value is 10 but may be set to any valid JavaScript number. Changes +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

            • Returns boolean

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

              The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

              +

              The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

              +

              The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

              +
              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
            diff --git a/docs/core/classes/TimeoutError.html b/docs/core/classes/TimeoutError.html index 81587f71..5c0b1ab2 100644 --- a/docs/core/classes/TimeoutError.html +++ b/docs/core/classes/TimeoutError.html @@ -1,15 +1,36 @@ TimeoutError | @nats-io/nats-core
            @nats-io/nats-core
              Preparing search index...

              Class TimeoutError

              TimeoutError is a custom error class that extends the built-in Error class. It is used to represent an error that occurs when an operation exceeds a predefined time limit.

              -

              Hierarchy

              • Error
                • TimeoutError
              Index

              Constructors

              constructor +

              Hierarchy

              • Error
                • TimeoutError
              Index

              Constructors

              constructor

              Properties

              cause? message name stack? -prepareStackTrace? stackTraceLimit

              Methods

              captureStackTrace -

              Constructors

              • Parameters

                • Optionaloptions: ErrorOptions

                Returns TimeoutError

              Properties

              cause?: unknown
              message: string
              name: string
              stack?: string
              prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

              Optional override for formatting stack traces

              -

              https://v8.dev/docs/stack-trace-api#customizing-stack-traces

              -
              stackTraceLimit: number

              Methods

              • Create .stack property on a target object

                -

                Parameters

                • targetObject: object
                • OptionalconstructorOpt: Function

                Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Methods
              +prepareStackTrace +

              Constructors

              • Parameters

                • Optionaloptions: ErrorOptions

                Returns TimeoutError

              Properties

              cause?: unknown
              message: string
              name: string
              stack?: string
              stackTraceLimit: number

              The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

              +

              The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
                + +

                The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                +

                The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                +

                The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                +
                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
              diff --git a/docs/core/classes/UserAuthenticationExpiredError.html b/docs/core/classes/UserAuthenticationExpiredError.html index be012ad3..35bba951 100644 --- a/docs/core/classes/UserAuthenticationExpiredError.html +++ b/docs/core/classes/UserAuthenticationExpiredError.html @@ -1,16 +1,37 @@ UserAuthenticationExpiredError | @nats-io/nats-core
              @nats-io/nats-core
                Preparing search index...

                Class UserAuthenticationExpiredError

                Represents an error indicating that user authentication has expired. This error is typically thrown when a user attempts to access a connection but their authentication credentials have expired.

                -

                Hierarchy

                • Error
                  • UserAuthenticationExpiredError
                Index

                Constructors

                constructor +

                Hierarchy

                • Error
                  • UserAuthenticationExpiredError
                Index

                Constructors

                constructor

                Properties

                cause? message name stack? -prepareStackTrace? stackTraceLimit

                Methods

                captureStackTrace parse -

                Constructors

                Properties

                cause?: unknown
                message: string
                name: string
                stack?: string
                prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                Optional override for formatting stack traces

                -

                https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                -
                stackTraceLimit: number

                Methods

                • Create .stack property on a target object

                  -

                  Parameters

                  • targetObject: object
                  • OptionalconstructorOpt: Function

                  Returns void

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Methods
                +prepareStackTrace +

                Constructors

                Properties

                cause?: unknown
                message: string
                name: string
                stack?: string
                stackTraceLimit: number

                The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

                +

                The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
                  + +

                  The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                  +

                  The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                  +

                  The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                  +
                  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
                diff --git a/docs/core/classes/nkeys.NKeysError.html b/docs/core/classes/nkeys.NKeysError.html index ba045397..da01df9d 100644 --- a/docs/core/classes/nkeys.NKeysError.html +++ b/docs/core/classes/nkeys.NKeysError.html @@ -1,13 +1,34 @@ -NKeysError | @nats-io/nats-core
                @nats-io/nats-core
                  Preparing search index...

                  Class NKeysError

                  Hierarchy

                  • Error
                    • NKeysError
                  Index

                  Constructors

                  constructor +NKeysError | @nats-io/nats-core
                  @nats-io/nats-core
                    Preparing search index...

                    Class NKeysError

                    Hierarchy

                    • Error
                      • NKeysError
                    Index

                    Constructors

                    constructor

                    Properties

                    cause? code message name stack? -prepareStackTrace? stackTraceLimit

                    Methods

                    captureStackTrace -

                    Constructors

                    Properties

                    cause?: unknown
                    code: string
                    message: string
                    name: string
                    stack?: string
                    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                    Optional override for formatting stack traces

                    -

                    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                    -
                    stackTraceLimit: number

                    Methods

                    • Create .stack property on a target object

                      -

                      Parameters

                      • targetObject: object
                      • OptionalconstructorOpt: Function

                      Returns void

                    Settings

                    Member Visibility

                    On This Page

                    Constructors
                    Properties
                    Methods
                    +prepareStackTrace +

                    Constructors

                    Properties

                    cause?: unknown
                    code: string
                    message: string
                    name: string
                    stack?: string
                    stackTraceLimit: number

                    The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

                    +

                    The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
                      + +

                      The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                      +

                      The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                      +

                      The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                      +
                      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
                    diff --git a/docs/core/functions/wsconnect.html b/docs/core/functions/wsconnect.html index 347e2297..1aadf005 100644 --- a/docs/core/functions/wsconnect.html +++ b/docs/core/functions/wsconnect.html @@ -1 +1 @@ -wsconnect | @nats-io/nats-core
                    @nats-io/nats-core
                      Preparing search index...

                      Function wsconnect

                      Settings

                      Member Visibility
                      +wsconnect | @nats-io/nats-core
                      @nats-io/nats-core
                        Preparing search index...

                        Function wsconnect

                        Settings

                        Member Visibility
                        diff --git a/docs/core/hierarchy.html b/docs/core/hierarchy.html index f87a2ff2..ea5f79a2 100644 --- a/docs/core/hierarchy.html +++ b/docs/core/hierarchy.html @@ -1 +1 @@ -@nats-io/nats-core
                        @nats-io/nats-core
                          Preparing search index...

                          @nats-io/nats-core

                          Hierarchy Summary

                          Settings

                          Member Visibility
                          +@nats-io/nats-core
                          @nats-io/nats-core
                            Preparing search index...

                            @nats-io/nats-core

                            Hierarchy Summary

                            Settings

                            Member Visibility
                            diff --git a/docs/core/index.html b/docs/core/index.html index 5b4b2cb8..67551ad7 100644 --- a/docs/core/index.html +++ b/docs/core/index.html @@ -1,5 +1,5 @@ @nats-io/nats-core
                            @nats-io/nats-core
                              Preparing search index...

                              @nats-io/nats-core

                              License -nats-core +nats-core JSDoc

                              JSR JSR

                              @@ -145,7 +145,7 @@

                              Here's an example of a service. It is a bit more complicated than expected simply to illustrate not only how to create responses, but how the subject itself is used to dispatch different behaviors.

                              -
                              import { connect, Subscription } from "@nats-io/nats-deno";

                              // create a connection
                              const nc = await connect({ servers: "demo.nats.io" });

                              // this subscription listens for `time` requests and returns the current time
                              const sub = nc.subscribe("time");
                              (async (sub: Subscription) => {
                                console.log(`listening for ${sub.getSubject()} requests...`);
                                for await (const m of sub) {
                                  if (m.respond(new Date().toISOString())) {
                                    console.info(`[time] handled #${sub.getProcessed()}`);
                                  } else {
                                    console.log(`[time] #${sub.getProcessed()} ignored - no reply subject`);
                                  }
                                }
                                console.log(`subscription ${sub.getSubject()} drained.`);
                              })(sub);

                              // this subscription listens for admin.uptime and admin.stop
                              // requests to admin.uptime returns how long the service has been running
                              // requests to admin.stop gracefully stop the client by draining
                              // the connection
                              const started = Date.now();
                              const msub = nc.subscribe("admin.*");
                              (async (sub: Subscription) => {
                                console.log(`listening for ${sub.getSubject()} requests [uptime | stop]`);
                                // it would be very good to verify the origin of the request
                                // before implementing something that allows your service to be managed.
                                // NATS can limit which client can send or receive on what subjects.
                                for await (const m of sub) {
                                  const chunks = m.subject.split(".");
                                  console.info(`[admin] #${sub.getProcessed()} handling ${chunks[1]}`);
                                  switch (chunks[1]) {
                                    case "uptime":
                                      // send the number of millis since up
                                      m.respond(`${Date.now() - started}`);
                                      break;
                                    case "stop": {
                                      m.respond((`[admin] #${sub.getProcessed()} stopping....`);
                                      // gracefully shutdown
                                      nc.drain()
                                        .catch((err) => {
                                          console.log("error draining", err);
                                        });
                                      break;
                                    }
                                    default:
                                      console.log(
                                        `[admin] #${sub.getProcessed()} ignoring request for ${m.subject}`,
                                      );
                                  }
                                }
                                console.log(`subscription ${sub.getSubject()} drained.`);
                              })(msub);

                              // wait for the client to close here.
                              await nc.closed().then((err?: void | Error) => {
                                let m = `connection to ${nc.getServer()} closed`;
                                if (err) {
                                  m = `${m} with an error: ${err.message}`;
                                }
                                console.log(m);
                              });
+
                              import { connect, Subscription } from "@nats-io/nats-deno";

                              // create a connection
                              const nc = await connect({ servers: "demo.nats.io" });

                              // this subscription listens for `time` requests and returns the current time
                              const sub = nc.subscribe("time");
                              (async (sub: Subscription) => {
                                console.log(`listening for ${sub.getSubject()} requests...`);
                                for await (const m of sub) {
                                  if (m.respond(new Date().toISOString())) {
                                    console.info(`[time] handled #${sub.getProcessed()}`);
                                  } else {
                                    console.log(`[time] #${sub.getProcessed()} ignored - no reply subject`);
                                  }
                                }
                                console.log(`subscription ${sub.getSubject()} drained.`);
                              })(sub);

                              // this subscription listens for admin.uptime and admin.stop
                              // requests to admin.uptime returns how long the service has been running
                              // requests to admin.stop gracefully stop the client by draining
                              // the connection
                              const started = Date.now();
                              const msub = nc.subscribe("admin.*");
                              (async (sub: Subscription) => {
                                console.log(`listening for ${sub.getSubject()} requests [uptime | stop]`);
                                // it would be very good to verify the origin of the request
                                // before implementing something that allows your service to be managed.
                                // NATS can limit which client can send or receive on what subjects.
                                for await (const m of sub) {
                                  const chunks = m.subject.split(".");
                                  console.info(`[admin] #${sub.getProcessed()} handling ${chunks[1]}`);
                                  switch (chunks[1]) {
                                    case "uptime":
                                      // send the number of millis since up
                                      m.respond(`${Date.now() - started}`);
                                      break;
                                    case "stop": {
                                      m.respond(`[admin] #${sub.getProcessed()} stopping....`);
                                      // gracefully shutdown
                                      nc.drain()
                                        .catch((err) => {
                                          console.log("error draining", err);
                                        });
                                      break;
                                    }
                                    default:
                                      console.log(
                                        `[admin] #${sub.getProcessed()} ignoring request for ${m.subject}`,
                                      );
                                  }
                                }
                                console.log(`subscription ${sub.getSubject()} drained.`);
                              })(msub);

                              // wait for the client to close here.
                              await nc.closed().then((err?: void | Error) => {
                                let m = `connection to ${nc.getServer()} closed`;
                                if (err) {
                                  m = `${m} with an error: ${err.message}`;
                                }
                                console.log(m);
                              });
 
                              
 
 
                              Here's a simple example of a client making a simple request from the service
diff --git a/docs/core/interfaces/ConnectionOptions.html b/docs/core/interfaces/ConnectionOptions.html
index 7b7c206d..3a8a4dc4 100644
--- a/docs/core/interfaces/ConnectionOptions.html
+++ b/docs/core/interfaces/ConnectionOptions.html
@@ -1,4 +1,4 @@
-ConnectionOptions | @nats-io/nats-core
                              @nats-io/nats-core
                                Preparing search index...
                                Interface ConnectionOptions
                                interface ConnectionOptions {
                                    authenticator?: Authenticator | Authenticator[];
                                    debug?: boolean;
                                    ignoreAuthErrorAbort?: boolean;
                                    ignoreClusterUpdates?: boolean;
                                    inboxPrefix?: string;
                                    maxPingOut?: number;
                                    maxReconnectAttempts?: number;
                                    name?: string;
                                    noAsyncTraces?: boolean;
                                    noEcho?: boolean;
                                    noRandomize?: boolean;
                                    pass?: string;
                                    pedantic?: boolean;
                                    pingInterval?: number;
                                    port?: number;
                                    reconnect?: boolean;
                                    reconnectDelayHandler?: () => number;
                                    reconnectJitter?: number;
                                    reconnectJitterTLS?: number;
                                    reconnectTimeWait?: number;
                                    resolve?: boolean;
                                    servers?: string | string[];
                                    timeout?: number;
                                    tls?: TlsOptions;
                                    token?: string;
                                    user?: string;
                                    verbose?: boolean;
                                    waitOnFirstConnect?: boolean;
                                }
                                Index
                                Properties
                                authenticator?
+ConnectionOptions | @nats-io/nats-core
                                @nats-io/nats-core
                                  Preparing search index...
                                  Interface ConnectionOptions
                                  interface ConnectionOptions {
                                      authenticator?: Authenticator | Authenticator[];
                                      debug?: boolean;
                                      ignoreAuthErrorAbort?: boolean;
                                      ignoreClusterUpdates?: boolean;
                                      inboxPrefix?: string;
                                      maxPingOut?: number;
                                      maxReconnectAttempts?: number;
                                      name?: string;
                                      noAsyncTraces?: boolean;
                                      noEcho?: boolean;
                                      noRandomize?: boolean;
                                      pass?: string;
                                      pedantic?: boolean;
                                      pingInterval?: number;
                                      port?: number;
                                      reconnect?: boolean;
                                      reconnectDelayHandler?: () => number;
                                      reconnectJitter?: number;
                                      reconnectJitterTLS?: number;
                                      reconnectTimeWait?: number;
                                      resolve?: boolean;
                                      servers?: string | string[];
                                      timeout?: number;
                                      tls?: TlsOptions;
                                      token?: string;
                                      user?: string;
                                      verbose?: boolean;
                                      waitOnFirstConnect?: boolean;
                                  }
                                  Hierarchy (View Summary)
                                  Index
                                  Properties
                                  authenticator?
 debug?
 ignoreAuthErrorAbort?
 ignoreClusterUpdates?
diff --git a/docs/core/interfaces/Deferred.html b/docs/core/interfaces/Deferred.html
index c0c8466d..c2ee54ef 100644
--- a/docs/core/interfaces/Deferred.html
+++ b/docs/core/interfaces/Deferred.html
@@ -1,4 +1,4 @@
-Deferred | @nats-io/nats-core
                                  @nats-io/nats-core
                                    Preparing search index...
                                    Interface Deferred<T>
                                    interface Deferred<T> {
                                        "[toStringTag]": string;
                                        reject: (reason?: any) => void;
                                        resolve: (value?: T | PromiseLike<T>) => void;
                                        catch<TResult = never>(
                                            onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
                                        ): Promise<T | TResult>;
                                        finally(onfinally?: () => void): Promise<T>;
                                        then<TResult1 = T, TResult2 = never>(
                                            onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>,
                                            onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
                                        ): Promise<TResult1 | TResult2>;
                                    }
                                    Type Parameters
                                    • T
                                    Hierarchy
                                    • Promise<T>
                                      • Deferred
                                    Index
                                    Properties
                                    [toStringTag]
+Deferred | @nats-io/nats-core
                                    @nats-io/nats-core
                                      Preparing search index...
                                      Interface Deferred<T>
                                      interface Deferred<T> {
                                          "[toStringTag]": string;
                                          reject: (reason?: any) => void;
                                          resolve: (value?: T | PromiseLike<T>) => void;
                                          catch<TResult = never>(
                                              onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
                                          ): Promise<T | TResult>;
                                          finally(onfinally?: () => void): Promise<T>;
                                          then<TResult1 = T, TResult2 = never>(
                                              onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>,
                                              onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
                                          ): Promise<TResult1 | TResult2>;
                                      }
                                      Type Parameters
                                      • T
                                      Hierarchy
                                      • Promise<T>
                                        • Deferred
                                      Index
                                      Properties
                                      [toStringTag]
 reject
 resolve
 
                                      Methods
                                      catch
diff --git a/docs/core/interfaces/Delay.html b/docs/core/interfaces/Delay.html
index 4f098194..5c5b3928 100644
--- a/docs/core/interfaces/Delay.html
+++ b/docs/core/interfaces/Delay.html
@@ -1,4 +1,4 @@
-Delay | @nats-io/nats-core
                                      @nats-io/nats-core
                                        Preparing search index...
                                        Interface Delay
                                        interface Delay {
                                            "[toStringTag]": string;
                                            cancel: () => void;
                                            catch<TResult = never>(
                                                onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
                                            ): Promise<void | TResult>;
                                            finally(onfinally?: () => void): Promise<void>;
                                            then<TResult1 = void, TResult2 = never>(
                                                onfulfilled?: (value: void) => TResult1 | PromiseLike<TResult1>,
                                                onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
                                            ): Promise<TResult1 | TResult2>;
                                        }
                                        Hierarchy
                                        • Promise<void>
                                          • Delay
                                        Index
                                        Properties
                                        [toStringTag]
+Delay | @nats-io/nats-core
                                        @nats-io/nats-core
                                          Preparing search index...
                                          Interface Delay
                                          interface Delay {
                                              "[toStringTag]": string;
                                              cancel: () => void;
                                              catch<TResult = never>(
                                                  onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
                                              ): Promise<void | TResult>;
                                              finally(onfinally?: () => void): Promise<void>;
                                              then<TResult1 = void, TResult2 = never>(
                                                  onfulfilled?: (value: void) => TResult1 | PromiseLike<TResult1>,
                                                  onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
                                              ): Promise<TResult1 | TResult2>;
                                          }
                                          Hierarchy
                                          • Promise<void>
                                            • Delay
                                          Index
                                          Properties
                                          [toStringTag]
 cancel
 
                                          Methods
                                          catch
 finally
diff --git a/docs/core/interfaces/MsgHdrs.html b/docs/core/interfaces/MsgHdrs.html
index 0036c3b0..c1e91d3d 100644
--- a/docs/core/interfaces/MsgHdrs.html
+++ b/docs/core/interfaces/MsgHdrs.html
@@ -1,4 +1,4 @@
-MsgHdrs | @nats-io/nats-core
                                          @nats-io/nats-core
                                            Preparing search index...
                                            Interface MsgHdrs
                                            interface MsgHdrs {
                                                code: number;
                                                description: string;
                                                hasError: boolean;
                                                status: string;
                                                "[iterator]"(): Iterator<[string, string[]], any, any>;
                                                append(k: string, v: string, match?: Match): void;
                                                delete(k: string, match?: Match): void;
                                                get(k: string, match?: Match): string;
                                                has(k: string, match?: Match): boolean;
                                                keys(): string[];
                                                last(k: string, match?: Match): string;
                                                set(k: string, v: string, match?: Match): void;
                                                values(k: string, match?: Match): string[];
                                            }
                                            Hierarchy
                                            • Iterable<[string, string[]]>
                                              • MsgHdrs
                                            Implemented by
                                            Index
                                            Properties
                                            code
+MsgHdrs | @nats-io/nats-core
                                            @nats-io/nats-core
                                              Preparing search index...
                                              Interface MsgHdrs
                                              interface MsgHdrs {
                                                  code: number;
                                                  description: string;
                                                  hasError: boolean;
                                                  status: string;
                                                  "[iterator]"(): Iterator<[string, string[]], any, any>;
                                                  append(k: string, v: string, match?: Match): void;
                                                  delete(k: string, match?: Match): void;
                                                  get(k: string, match?: Match): string;
                                                  has(k: string, match?: Match): boolean;
                                                  keys(): string[];
                                                  last(k: string, match?: Match): string;
                                                  set(k: string, v: string, match?: Match): void;
                                                  values(k: string, match?: Match): string[];
                                              }
                                              Hierarchy
                                              • Iterable<[string, string[]]>
                                                • MsgHdrs
                                              Implemented by
                                              Index
                                              Properties
                                              code
 description
 hasError
 status
diff --git a/docs/core/interfaces/PublishOptions.html b/docs/core/interfaces/PublishOptions.html
index a4bab817..90a642c4 100644
--- a/docs/core/interfaces/PublishOptions.html
+++ b/docs/core/interfaces/PublishOptions.html
@@ -1,4 +1,4 @@
-PublishOptions | @nats-io/nats-core
                                              @nats-io/nats-core
                                                Preparing search index...
                                                Interface PublishOptions
                                                interface PublishOptions {
                                                    headers?: MsgHdrs;
                                                    reply?: string;
                                                    traceDestination?: string;
                                                    traceOnly?: boolean;
                                                }
                                                Hierarchy
                                                • TraceOptions
                                                  • PublishOptions
                                                Index
                                                Properties
                                                headers?
+PublishOptions | @nats-io/nats-core
                                                @nats-io/nats-core
                                                  Preparing search index...
                                                  Interface PublishOptions
                                                  interface PublishOptions {
                                                      headers?: MsgHdrs;
                                                      reply?: string;
                                                      traceDestination?: string;
                                                      traceOnly?: boolean;
                                                  }
                                                  Hierarchy
                                                  • TraceOptions
                                                    • PublishOptions
                                                  Index
                                                  Properties
                                                  headers?
 reply?
 traceDestination?
 traceOnly?
diff --git a/docs/core/interfaces/RequestManyOptions.html b/docs/core/interfaces/RequestManyOptions.html
index d61b08a3..141447eb 100644
--- a/docs/core/interfaces/RequestManyOptions.html
+++ b/docs/core/interfaces/RequestManyOptions.html
@@ -1,4 +1,4 @@
-RequestManyOptions | @nats-io/nats-core
                                                  @nats-io/nats-core
                                                    Preparing search index...
                                                    Interface RequestManyOptions
                                                    interface RequestManyOptions {
                                                        headers?: MsgHdrs;
                                                        maxMessages?: number;
                                                        maxWait: number;
                                                        noMux?: boolean;
                                                        stall?: number;
                                                        strategy: RequestStrategy;
                                                        traceDestination?: string;
                                                        traceOnly?: boolean;
                                                    }
                                                    Hierarchy
                                                    • TraceOptions
                                                      • RequestManyOptions
                                                    Index
                                                    Properties
                                                    headers?
+RequestManyOptions | @nats-io/nats-core
                                                    @nats-io/nats-core
                                                      Preparing search index...
                                                      Interface RequestManyOptions
                                                      interface RequestManyOptions {
                                                          headers?: MsgHdrs;
                                                          maxMessages?: number;
                                                          maxWait: number;
                                                          noMux?: boolean;
                                                          stall?: number;
                                                          strategy: RequestStrategy;
                                                          traceDestination?: string;
                                                          traceOnly?: boolean;
                                                      }
                                                      Hierarchy
                                                      • TraceOptions
                                                        • RequestManyOptions
                                                      Index
                                                      Properties
                                                      headers?
 maxMessages?
 maxWait
 noMux?
diff --git a/docs/core/interfaces/RequestOptions.html b/docs/core/interfaces/RequestOptions.html
index 5f1bf3cc..e571c38f 100644
--- a/docs/core/interfaces/RequestOptions.html
+++ b/docs/core/interfaces/RequestOptions.html
@@ -1,4 +1,4 @@
-RequestOptions | @nats-io/nats-core
                                                      @nats-io/nats-core
                                                        Preparing search index...
                                                        Interface RequestOptions
                                                        interface RequestOptions {
                                                            headers?: MsgHdrs;
                                                            noMux?: boolean;
                                                            reply?: string;
                                                            timeout: number;
                                                            traceDestination?: string;
                                                            traceOnly?: boolean;
                                                        }
                                                        Hierarchy
                                                        • TraceOptions
                                                          • RequestOptions
                                                        Index
                                                        Properties
                                                        headers?
+RequestOptions | @nats-io/nats-core
                                                        @nats-io/nats-core
                                                          Preparing search index...
                                                          Interface RequestOptions
                                                          interface RequestOptions {
                                                              headers?: MsgHdrs;
                                                              noMux?: boolean;
                                                              reply?: string;
                                                              timeout: number;
                                                              traceDestination?: string;
                                                              traceOnly?: boolean;
                                                          }
                                                          Hierarchy
                                                          • TraceOptions
                                                            • RequestOptions
                                                          Index
                                                          Properties
                                                          headers?
 noMux?
 reply?
 timeout
diff --git a/docs/core/interfaces/Subscription.html b/docs/core/interfaces/Subscription.html
index 6dd21fdc..a9cb28f9 100644
--- a/docs/core/interfaces/Subscription.html
+++ b/docs/core/interfaces/Subscription.html
@@ -1,5 +1,5 @@
 Subscription | @nats-io/nats-core
                                                          @nats-io/nats-core
                                                            Preparing search index...
                                                            Interface Subscription
                                                            Basic interface to a Subscription type
                                                            
-
                                                            interface Subscription {
                                                                closed: Promise<void | Error>;
                                                                "[asyncIterator]"(): AsyncIterator<Msg, any, any>;
                                                                drain(): Promise<void>;
                                                                getMax(): number;
                                                                getPending(): number;
                                                                getProcessed(): number;
                                                                getReceived(): number;
                                                                getSubject(): string;
                                                                isClosed(): boolean;
                                                                isDraining(): boolean;
                                                                unsubscribe(max?: number): void;
                                                            }
                                                            Hierarchy
                                                            • AsyncIterable<Msg>
                                                              • Subscription
                                                            Index
                                                            Properties
                                                            closed
+
                                                            interface Subscription {
                                                                closed: Promise<void | Error>;
                                                                "[asyncIterator]"(): AsyncIterator<Msg, any, any>;
                                                                drain(): Promise<void>;
                                                                getMax(): number;
                                                                getPending(): number;
                                                                getProcessed(): number;
                                                                getReceived(): number;
                                                                getSubject(): string;
                                                                isClosed(): boolean;
                                                                isDraining(): boolean;
                                                                unsubscribe(max?: number): void;
                                                            }
                                                            Hierarchy
                                                            • AsyncIterable<Msg>
                                                              • Subscription
                                                            Index
                                                            Properties
                                                            closed
 
                                                            Methods
                                                            [asyncIterator]
 drain
 getMax
diff --git a/docs/core/interfaces/Timeout.html b/docs/core/interfaces/Timeout.html
index 29ce3aca..bf14b5d6 100644
--- a/docs/core/interfaces/Timeout.html
+++ b/docs/core/interfaces/Timeout.html
@@ -1,4 +1,4 @@
-Timeout | @nats-io/nats-core
                                                            @nats-io/nats-core
                                                              Preparing search index...
                                                              Interface Timeout<T>
                                                              interface Timeout<T> {
                                                                  "[toStringTag]": string;
                                                                  cancel: () => void;
                                                                  catch<TResult = never>(
                                                                      onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
                                                                  ): Promise<T | TResult>;
                                                                  finally(onfinally?: () => void): Promise<T>;
                                                                  then<TResult1 = T, TResult2 = never>(
                                                                      onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>,
                                                                      onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
                                                                  ): Promise<TResult1 | TResult2>;
                                                              }
                                                              Type Parameters
                                                              • T
                                                              Hierarchy
                                                              • Promise<T>
                                                                • Timeout
                                                              Index
                                                              Properties
                                                              [toStringTag]
+Timeout | @nats-io/nats-core
                                                              @nats-io/nats-core
                                                                Preparing search index...
                                                                Interface Timeout<T>
                                                                interface Timeout<T> {
                                                                    "[toStringTag]": string;
                                                                    cancel: () => void;
                                                                    catch<TResult = never>(
                                                                        onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
                                                                    ): Promise<T | TResult>;
                                                                    finally(onfinally?: () => void): Promise<T>;
                                                                    then<TResult1 = T, TResult2 = never>(
                                                                        onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>,
                                                                        onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
                                                                    ): Promise<TResult1 | TResult2>;
                                                                }
                                                                Type Parameters
                                                                • T
                                                                Hierarchy
                                                                • Promise<T>
                                                                  • Timeout
                                                                Index
                                                                Properties
                                                                [toStringTag]
 cancel
 
                                                                Methods
                                                                catch
 finally
diff --git a/docs/core/interfaces/WsConnectionOptions.html b/docs/core/interfaces/WsConnectionOptions.html
new file mode 100644
index 00000000..89f7a103
--- /dev/null
+++ b/docs/core/interfaces/WsConnectionOptions.html
@@ -0,0 +1,125 @@
+WsConnectionOptions | @nats-io/nats-core
                                                                @nats-io/nats-core
                                                                  Preparing search index...
                                                                  Interface WsConnectionOptions
                                                                  WsConnectionOptions exposes wsconnect specific options not applicable to
+other transports.
                                                                  
+
                                                                  interface WsConnectionOptions {
                                                                      authenticator?: Authenticator | Authenticator[];
                                                                      debug?: boolean;
                                                                      ignoreAuthErrorAbort?: boolean;
                                                                      ignoreClusterUpdates?: boolean;
                                                                      inboxPrefix?: string;
                                                                      maxPingOut?: number;
                                                                      maxReconnectAttempts?: number;
                                                                      name?: string;
                                                                      noAsyncTraces?: boolean;
                                                                      noEcho?: boolean;
                                                                      noRandomize?: boolean;
                                                                      pass?: string;
                                                                      pedantic?: boolean;
                                                                      pingInterval?: number;
                                                                      port?: number;
                                                                      reconnect?: boolean;
                                                                      reconnectDelayHandler?: () => number;
                                                                      reconnectJitter?: number;
                                                                      reconnectJitterTLS?: number;
                                                                      reconnectTimeWait?: number;
                                                                      resolve?: boolean;
                                                                      servers?: string | string[];
                                                                      timeout?: number;
                                                                      tls?: TlsOptions;
                                                                      token?: string;
                                                                      user?: string;
                                                                      verbose?: boolean;
                                                                      waitOnFirstConnect?: boolean;
                                                                      wsFactory?: WsSocketFactory;
                                                                  }
                                                                  Hierarchy (View Summary)
                                                                  Index
                                                                  Properties
                                                                  authenticator?
+debug?
+ignoreAuthErrorAbort?
+ignoreClusterUpdates?
+inboxPrefix?
+maxPingOut?
+maxReconnectAttempts?
+name?
+noAsyncTraces?
+noEcho?
+noRandomize?
+pass?
+pedantic?
+pingInterval?
+port?
+reconnect?
+reconnectDelayHandler?
+reconnectJitter?
+reconnectJitterTLS?
+reconnectTimeWait?
+resolve?
+servers?
+timeout?
+tls?
+token?
+user?
+verbose?
+waitOnFirstConnect?
+wsFactory?
+
                                                                  Properties
                                                                  authenticator?: Authenticator | Authenticator[]
                                                                  When the server requires authentication, set an Authenticator.
+An authenticator is created automatically for username/password and token
+authentication configurations
+if user and pass or the token options are set.
                                                                  
+
                                                                  debug?: boolean
                                                                  When set to true the client will print protocol messages that it receives
+or sends to the server.
                                                                  
+
                                                                  ignoreAuthErrorAbort?: boolean
                                                                  By default, NATS clients will abort reconnect if they fail authentication
+twice in a row with the same error, regardless of the reconnect policy.
+This option should be used with care as it will disable this behaviour when true
                                                                  
+
                                                                  ignoreClusterUpdates?: boolean
                                                                  When set to true, cluster information gossiped by the nats-server will
+not augment the lists of server(s) known by the client.
                                                                  
+
                                                                  inboxPrefix?: string
                                                                  A string prefix (must be a valid subject prefix) prepended to inboxes
+generated by client. This allows a client with limited subject permissions
+to specify a subject where requests can deliver responses.
                                                                  
+
                                                                  maxPingOut?: number
                                                                  Sets the maximum count of ping commands that can be awaiting a response
+before raising a stale connection status StaleConnectionStatus
+notification NatsConnection#status and initiating a reconnect.
                                                                  
+
                                                                  pingInterval
                                                                  
+
                                                                  maxReconnectAttempts?: number
                                                                  Sets the maximum count of per-server reconnect attempts before giving up.
+Set to -1 to never give up.
                                                                  
+
                                                                  10
+
                                                                  
+
+
                                                                  name?: string
                                                                  Sets the client name. When set, the server monitoring pages will display
+this name when referring to this client.
                                                                  
+
                                                                  noAsyncTraces?: boolean
                                                                  When true, the client will not augment timeout and other error traces with
+additional context as to where the operation was started.
                                                                  
+
                                                                  noEcho?: boolean
                                                                  When set to true, messages published by this client will not match
+this client's subscriptions, so the client is guaranteed to never
+receive self-published messages on a subject that it is listening on.
                                                                  
+
                                                                  noRandomize?: boolean
                                                                  If set to true, the client will not randomize its server connection list.
                                                                  
+
                                                                  pass?: string
                                                                  Sets the password for a client connection. Requires that the user
+option be set. See authenticator.
                                                                  
+
                                                                  pedantic?: boolean
                                                                  When set to true, the server may perform additional checks on protocol
+message requests. This option is only useful for NATS client development
+and shouldn't be used, as it affects server performance.
                                                                  
+
                                                                  pingInterval?: number
                                                                  Sets the number of milliseconds between client initiated ping commands.
+See maxPingOut.
                                                                  
+
                                                                  2 minutes.
+
                                                                  
+
+
                                                                  port?: number
                                                                  Sets the port number on the localhost (127.0.0.1) where the nats-server is running.
+This option is mutually exclusive with servers.
                                                                  
+
                                                                  reconnect?: boolean
                                                                  When set to true, the server will attempt to reconnect so long as
+maxReconnectAttempts doesn't prevent it.
                                                                  
+
                                                                  true
+
                                                                  
+
+
                                                                  reconnectDelayHandler?: () => number
                                                                  Set a function that dynamically determines the number of milliseconds
+that the client should wait for the next reconnect attempt.
                                                                  
+
                                                                  reconnectJitter?: number
                                                                  Set the upper bound for a random delay in milliseconds added to
+reconnectTimeWait.
                                                                  
+
                                                                  100 millis
+
                                                                  
+
+
                                                                  reconnectJitterTLS?: number
                                                                  Set the upper bound for a random delay in milliseconds added to
+reconnectTimeWait. This only affects TLS connections
                                                                  
+
                                                                  1000 millis
+
                                                                  
+
+
                                                                  reconnectTimeWait?: number
                                                                  Set the number of millisecods between reconnect attempts.
                                                                  
+
                                                                  2000 millis
+
                                                                  
+
+
                                                                  resolve?: boolean
                                                                  When false, the connect function will not perform any hostname resolution. Note that
+by default this option will be true if the client supports hostname resolution.
+Note that on clients that don't supported (mainly the websocket client, setting this
+option to true, will throw an exception as this option is not available.
                                                                  
+
                                                                  servers?: string | string[]
                                                                  Set the hostport(s) where the client should attempt to connect.
+This option is mutually exclusive with port.
                                                                  
+
                                                                  127.0.0.1:4222
+
                                                                  
+
+
                                                                  timeout?: number
                                                                  Sets the number of milliseconds the client should wait for a server
+handshake to be established.
                                                                  
+
                                                                  20000 millis
+
                                                                  
+
+
                                                                  tls?: TlsOptions
                                                                  When set (can be an empty object), the client requires a secure connection.
+TlsOptions honored depend on the runtime. Consult the specific NATS javascript
+client GitHub repo/documentation. When set to null, the client should fail
+should not connect using TLS. In the case where TLS is available on the server
+a standard connection will be used. If TLS is required, the connection will fail.
                                                                  
+
                                                                  token?: string
                                                                  Set to a client authentication token. Note that these tokens are
+a specific authentication strategy on the nats-server. This option
+is mutually exclusive of user and pass. See authenticator.
                                                                  
+
                                                                  user?: string
                                                                  Sets the username for a client connection. Requires that the pass
+option be set. See authenticator.
                                                                  
+
                                                                  verbose?: boolean
                                                                  When set to true, the server will send response to all server commands.
+This option is only useful for NATS client development and shouldn't
+be used, as it affects server performance.
                                                                  
+
                                                                  waitOnFirstConnect?: boolean
                                                                  When set to true maxReconnectAttempts will not trigger until the client
+has established one connection.
                                                                  
+
                                                                  wsFactory?: WsSocketFactory
                                                                  Settings
                                                                  Member Visibility
                                                                  On This Page
                                                                  Properties
                                                                  
diff --git a/docs/core/modules.html b/docs/core/modules.html
index 06bdcec1..124734e0 100644
--- a/docs/core/modules.html
+++ b/docs/core/modules.html
@@ -1 +1 @@
-@nats-io/nats-core
                                                                  @nats-io/nats-core
                                                                    Preparing search index...
                                                                      @nats-io/nats-core
                                                                      Namespaces
                                                                      nkeys
                                                                      Classes
                                                                      AuthorizationError
                                                                      Bench
                                                                      ClosedConnectionError
                                                                      ConnectionError
                                                                      DrainingConnectionError
                                                                      InvalidArgumentError
                                                                      InvalidOperationError
                                                                      InvalidSubjectError
                                                                      Metric
                                                                      MsgHdrsImpl
                                                                      NoRespondersError
                                                                      Nuid
                                                                      Perf
                                                                      PermissionViolationError
                                                                      ProtocolError
                                                                      RequestError
                                                                      TimeoutError
                                                                      UserAuthenticationExpiredError
                                                                      Interfaces
                                                                      Authenticator
                                                                      Backoff
                                                                      BenchOpts
                                                                      Codec
                                                                      ConnectionOptions
                                                                      Deferred
                                                                      Delay
                                                                      JwtAuth
                                                                      Msg
                                                                      MsgHdrs
                                                                      NatsConnection
                                                                      NKeyAuth
                                                                      Publisher
                                                                      PublishOptions
                                                                      QueuedIterator
                                                                      RequestManyOptions
                                                                      RequestOptions
                                                                      ServerInfo
                                                                      ServersChanged
                                                                      Stats
                                                                      SubOpts
                                                                      Subscription
                                                                      Timeout
                                                                      TlsOptions
                                                                      TokenAuth
                                                                      UserPass
                                                                      Type Aliases
                                                                      Auth
                                                                      ClientPingStatus
                                                                      CloseStatus
                                                                      ClusterUpdateStatus
                                                                      DisconnectStatus
                                                                      ForceReconnectStatus
                                                                      LDMStatus
                                                                      Match
                                                                      MsgCallback
                                                                      Nanos
                                                                      NoAuth
                                                                      Payload
                                                                      ReconnectingStatus
                                                                      ReconnectStatus
                                                                      RequestStrategy
                                                                      ReviverFn
                                                                      ServerErrorStatus
                                                                      SlowConsumerStatus
                                                                      StaleConnectionStatus
                                                                      Status
                                                                      SubscriptionOptions
                                                                      SyncIterator
                                                                      Variables
                                                                      Empty
                                                                      errors
                                                                      Match
                                                                      nuid
                                                                      Functions
                                                                      backoff
                                                                      buildAuthenticator
                                                                      canonicalMIMEHeaderKey
                                                                      createInbox
                                                                      credsAuthenticator
                                                                      deadline
                                                                      deferred
                                                                      delay
                                                                      hasWsProtocol
                                                                      headers
                                                                      jwtAuthenticator
                                                                      millis
                                                                      nanos
                                                                      nkeyAuthenticator
                                                                      syncIterator
                                                                      tokenAuthenticator
                                                                      usernamePasswordAuthenticator
                                                                      wsconnect
                                                                      Settings
                                                                      Member Visibility
                                                                      On This Page
                                                                      Namespaces
                                                                      Classes
                                                                      Interfaces
                                                                      Type Aliases
                                                                      Variables
                                                                      Functions
                                                                      
+@nats-io/nats-core
                                                                      @nats-io/nats-core
                                                                        Preparing search index...
                                                                          @nats-io/nats-core
                                                                          Namespaces
                                                                          nkeys
                                                                          Classes
                                                                          AuthorizationError
                                                                          Bench
                                                                          ClosedConnectionError
                                                                          ConnectionError
                                                                          DrainingConnectionError
                                                                          InvalidArgumentError
                                                                          InvalidOperationError
                                                                          InvalidSubjectError
                                                                          Metric
                                                                          MsgHdrsImpl
                                                                          NoRespondersError
                                                                          Nuid
                                                                          Perf
                                                                          PermissionViolationError
                                                                          ProtocolError
                                                                          RequestError
                                                                          TimeoutError
                                                                          UserAuthenticationExpiredError
                                                                          Interfaces
                                                                          Authenticator
                                                                          Backoff
                                                                          BenchOpts
                                                                          Codec
                                                                          ConnectionOptions
                                                                          Deferred
                                                                          Delay
                                                                          JwtAuth
                                                                          Msg
                                                                          MsgHdrs
                                                                          NatsConnection
                                                                          NKeyAuth
                                                                          Publisher
                                                                          PublishOptions
                                                                          QueuedIterator
                                                                          RequestManyOptions
                                                                          RequestOptions
                                                                          ServerInfo
                                                                          ServersChanged
                                                                          Stats
                                                                          SubOpts
                                                                          Subscription
                                                                          Timeout
                                                                          TlsOptions
                                                                          TokenAuth
                                                                          UserPass
                                                                          WsConnectionOptions
                                                                          Type Aliases
                                                                          Auth
                                                                          ClientPingStatus
                                                                          CloseStatus
                                                                          ClusterUpdateStatus
                                                                          DisconnectStatus
                                                                          ForceReconnectStatus
                                                                          LDMStatus
                                                                          Match
                                                                          MsgCallback
                                                                          Nanos
                                                                          NoAuth
                                                                          Payload
                                                                          ReconnectingStatus
                                                                          ReconnectStatus
                                                                          RequestStrategy
                                                                          ReviverFn
                                                                          ServerErrorStatus
                                                                          SlowConsumerStatus
                                                                          StaleConnectionStatus
                                                                          Status
                                                                          SubscriptionOptions
                                                                          SyncIterator
                                                                          WsSocketFactory
                                                                          Variables
                                                                          Empty
                                                                          errors
                                                                          Match
                                                                          nuid
                                                                          Functions
                                                                          backoff
                                                                          buildAuthenticator
                                                                          canonicalMIMEHeaderKey
                                                                          createInbox
                                                                          credsAuthenticator
                                                                          deadline
                                                                          deferred
                                                                          delay
                                                                          hasWsProtocol
                                                                          headers
                                                                          jwtAuthenticator
                                                                          millis
                                                                          nanos
                                                                          nkeyAuthenticator
                                                                          syncIterator
                                                                          tokenAuthenticator
                                                                          usernamePasswordAuthenticator
                                                                          wsconnect
                                                                          Settings
                                                                          Member Visibility
                                                                          On This Page
                                                                          Namespaces
                                                                          Classes
                                                                          Interfaces
                                                                          Type Aliases
                                                                          Variables
                                                                          Functions
                                                                          
diff --git a/docs/core/types/WsSocketFactory.html b/docs/core/types/WsSocketFactory.html
new file mode 100644
index 00000000..a365b815
--- /dev/null
+++ b/docs/core/types/WsSocketFactory.html
@@ -0,0 +1,8 @@
+WsSocketFactory | @nats-io/nats-core
                                                                          @nats-io/nats-core
                                                                            Preparing search index...
                                                                            Type Alias WsSocketFactory
                                                                            WsSocketFactory: (
                                                                                u: string,
                                                                                opts: ConnectionOptions,
                                                                            ) => Promise<{ encrypted: boolean; socket: WebSocket }>
                                                                            WsSocketFactory is a factory that returns a WebSocket and a boolean
+indicating if the connection is encrypted. Client code is responsible
+for creating a W3C WebSocket compliant transport.
                                                                            
+
                                                                            Type declaration
                                                                              • (
                                                                                    u: string,
                                                                                    opts: ConnectionOptions,
                                                                                ): Promise<{ encrypted: boolean; socket: WebSocket }>
                                                                              • Parameters
                                                                                Returns Promise<{ encrypted: boolean; socket: WebSocket }>
                                                                                a promise that resolves to a WebSocket and a boolean indicating if
+the connection is encrypted
                                                                                
+
                                                                            Settings
                                                                            Member Visibility
                                                                            
diff --git a/docs/jetstream/assets/hierarchy.js b/docs/jetstream/assets/hierarchy.js
index 88636f05..fb85f0ad 100644
--- a/docs/jetstream/assets/hierarchy.js
+++ b/docs/jetstream/assets/hierarchy.js
@@ -1 +1 @@
-window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzwMKVNfWAgCbHgqm"
\ No newline at end of file
+window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzytWsqqurQUAmx4Kpg=="
\ No newline at end of file
diff --git a/docs/jetstream/assets/navigation.js b/docs/jetstream/assets/navigation.js
index 3f3ac06a..130ea684 100644
--- a/docs/jetstream/assets/navigation.js
+++ b/docs/jetstream/assets/navigation.js
@@ -1 +1 @@
-window.navigationData = "eJydmktz2zYQx7+LzpmmcfrMzY+4dRvZGtk5dXqgSEhCTJEMALrWdPLdCz4kAtxd7rIne/Bf/AQC2OViwb/+XTj16hYfFn8o9+iMSg6Xlf5oTGkWbxZV4vZeSvPEWmXfApPv9u6Qe7tnXWSLD+8ufvn2BvI4GEu63JTGPRRLba0udmtly9qkaiC6Y+V5uFXMvfj+15/f/XgRstO0rAv3SR+0swAZijzpeVXmOj1CSi+whOxF29JAQN8u7f9noxOMRmM5YAP0DHTV0f6rZKfgGPp2af+1+lor6yhML3O0q8Sl++skzzdJ+jxmRSJLQub1SjCfV34TZava7q/LwtYHZR4qp/2/gEXYcfzrvLTAHdpGUU/wTF0r37e2Tpm7YltCwFliKeWhylXzmN5j6xws9ljnee3UXR2dAvMbakIOtW9GspC2VNb6nUsN7CQLacQuilUhC/j6qV3a/3J1RyG8JKWc5vO2oGCDhZhZFlu9I3mtKmb595VjJj42kpJvlN/liCvGspSGOmWgSTnYmyTUpBxm45uZO9/cl+62CZYU76TP4OmtTpNmySaYZxspd6WLgl7UTpWyyMkTz9rnopocz0kX86rMb/Rp/wptOO6N2tQA1DbyPRv3SDa5ouIZtBAw9YtfJDSni0Qh6Yh5ZajxHOtMeWweAmLOEkvRRqWuTXzwrBcYzCASoRFazGA+usS4R/V1AnoymUt90gc4lYiNjPspsT7swK0XijLS0u5+V0mGOP1YF/OIZHqsy3j9KRC+80cyT7NpYkBA6puFvQkPDUWO9PE1VSpTGe4QscqzKj8JCKRtFvT2x1iVUXFsrPM8n4gXSd4tCaSFKse6Vd4n0Mx6UEQMKh2IRBGJiDehxnLy8h8/mz585gAzSBzFu6NxG5/4jRlnQUywTQkDvqXHOse7y3JFjioSWZJ/N029W8c6xxvKSF19xYdZ6HSokZxc6esygzsMGMwhMuPsDcTE61yrAqzMSBbTlknhvQaszVifyyMcjDAT0znsXN6q3uTaUuGAMBPTPzcBiYS26jzWZNVxwpT9FUukDWeBJ/hcAPb2jVzPPsGhUw1gwBJ1U0UCmLaV7VvafhZvEpcARqRyrGXyir71Tu2C/tQbL5BYit11hxhiese6gEeThIz75s+od9Mm6Uf/fqxKWITfBxJLKdfKVmWBOU+ocZwH462G9IwYGG41k71WaVtpApkCZSfkCyrVtCX7G/6wu/Vp1VIXzb2IKjJdgHiDGs0g89j/zbwssm5UPPxsKv0VarJjmaOtFF7/O7Wz/fMkVQckMzkLLMHo0mh3/M2UdQUeJ1alLPyQF6ssq94gC9e18n3znFifQOIpZqeujkgxY1CkjHrzxR+1KU6nilh+7Mgz9YKI0IVHeAcViSLSk9EHcjwnkScNYQmCBm0Oh1z72RFwrao8IfZzqAk4XTaLQDpBTCCSxrHO86wCG7Jt5Hs6H1f87FHTEskczTsRnVxEooBUqyJVWDwNNZZzKiROjAua8NTS+MzxyfeHtLMkoajmmtX4RBS5/xjrIl6GnCLOAk/AalWyGlV/Fs/bupZD5iWShTRY5xRXOPuzPHpHEmpiThtq8IMjZiPjovv7rMgZ/cYlgiVlJ+PfJwd4fgokIYW4OYxVGYsYjXAkj+hXTKE2h0Ov4KALeY70m1aSUabuBqEFy+zSmSeTFHZbGsqfUCuenaY+skFY28z1ftr7sLgv8wytEMSqmEVVC4AB+yUV/CbtJTG6KdaS36W9jwDoJ2UBg/ysLMIQd6kDZ+I+NQaR12MBa/KKbIRDb5BCFnmLFIEmCs8DjCk+x0BYyQtAeDUvAlAHp4EydXiKUHjGOoDorHWMIdLNCDWRco5wRM4Y0ibyxvdsKjWAyHQKQPBMKibR2VSE07Y5WcKDzLYu0va9+Ta2iFE//TBCYWeiGEWdjCLUF+XsKD8bKGdRAgA3FggHvbXwuL//A8LJDe8="
\ No newline at end of file
+window.navigationData = "eJydmk1z2zYQhv+Lzpmm+Wja5iY7ceM2ijW2Mz10eoDIlYSYAhgAdK128t87pCgR4GK5q5w0g3f3IQRigcWCf/03C/AUZm9nv0O4Cw7Ubl7r985ZN3s2q1XYzt7Oikp5D/45MvlhG3bV7NnsQZty9vbFy1++PcM8DsaS5ivrwo1ZaO+12dyCt40rYCCGfQ3+ed4q5b788defX/z0MmYXhW1M+Kh3OniEjEWe9LC0lS72mNILLKF81N46DOjbpf5/tDrBaDWWgyZAz8i+9az/Um0A96Fvl/rfwtcGfKAwvczRLlQotmNG1yjynBcPWed58SDyv1RVtVIE5CiKSAvwXm3gpg7aGjRXMybfQf1Th+0t1BWag1O27HMy8/FCMA8vbGPKZeO3l9b4ZgeO+uuEHce/rKxHy0jXKPJE/+nQyvs2PoC7NmuLASeJpdhdXUH7N2/BNxUKkrHO87qhu9gHQOMba0IONetHspDWzzuqY0dZSCNmUaoKWWiNPLZL/efLawoxX15LKcfxvDIUbLAQM61Z6w3J61Qxy4EKzMCnRlLyO6ggZEIxlaW0bFBGmpST24FjTcphJr47c+a7TzZctYslxTvqZ/D0WheqfWUTzJONlLvUxtAv9aBKWeTgiUfts6kn+3PUxby6VAGm4yu24bjvYNUgUNfIe7bhoVYVUOsZthAw9SO4fC6ciELSPheVscZzfHB23/4JjDlJLEU7KEKXB+VPC8jgDCKxNGKLM5h3QblwB18noEeTc6n3eoeHMmMj435UPlzh40YiykgLv/kAqswE/VgX84hDyFiX8frTM97zRzJP84VyaEHqm4XeRITGIkd6/1QAlFDmAyJVeVatHd7q+maBt3UBSmodG+s8L4Azqjq8EkyLVY51BaHYZjPrQRExqHQgEUUkYr2JNZZT2X8urQnOVggzSBzlAygXVqBQgJ0EMcG3pR+8S491jnddVkD2KhFZklnbqb11rHO8ofx2qEvdBYWDLmskJ9f60pZ4hiGDc4hMP3sDMfGy0mDQmxnJYtpCGbXB72asn8sjAowwE9M57Lm8ZbOqtKeWA8JMTP/cLkgktFPPY01WaydM2ad4Im04CTxh4VEO3jVynn2CQ6cayIAl6raKhDBdK+trfT+K71RQiJGoHGuhnrK73rFd4E/teJHEUvzmcIghhnesC3g0Scj41P6MvNs2iR/9/FSVsIi4jySWYm/B19bkgifWOM6NK8EN6RnRsbzVmexbKLpKE8oUKDshX1Cppi3ZZzyCW1f2n4U27X0SmFIbtN5kjc4g89jvZs5NeegVDz+ZSp9CDXYqc7Ql5Ot/x3be33ntw8KWaMuLJJZSqQJ2mfzmJLAEp63TQf8LJTEw2ELI3P/mbFNTvF6VsvLHz1RlWc0qM6UOrQJfYtMfFJ5RVdQgDxJPcRu42GdKNYMiZTSrL1DgyZOoItZNjTOskyAiHBZ/fMOWiCLSvdM7sj9HkScNiy4GDdo5HPLdn72+txepioiJWBNwDrl6BnIQxAQiOsY6z/OAJmTXyHsGMO3oUcOSyBztrthC2VTULdRIZmnwlU7EElFAasAUkNt7Yo3lHIuuE/3CJjzVOrWB+32N4jiSJBRor6QdeJ+5KxrrIl6ZOXGdBJ6Qq+vJ6nl93aLqaoAhMy6JLKThmrC4GtzXPbL3SbEm5nQLV/6QnbORcd8/1VAElQ8+ZCFjZmPmpMgZfTBQSwNhJ+N/Ujt8fo0kIYW4uU1VGYvojbAnd9mv72LtHA79BgddyAtkLHaSjDJ1N4stWOYh4bp3yvi1dVSMZq14dlGAx+/y0Mx5328d+K2tymyFJlXFLKpagww4YuZbykfldFssJ7+nfJUAsp9CRgzyc8gEQ9xlD5yJ++wURF5PRqzJK8oRLnuDF7PIW7wENFH4H2BM8T8F4kpqBMpXUxNA9hg9IMijdAohzpgRZ+KcmaIyx8QIQxwVE0Q+tx8gdH4/xhCJeYKaSM5HOCK7jmkTGfardPHMpIkDiEwVESSfJaYkOlNMcNq3Z3B85Fs3puj27+epRYp683qEyp0eUxR1hkxQXyD4Ue45UE6iBIBurjKc7O3Vm9ff/v4f6VEmjQ=="
\ No newline at end of file
diff --git a/docs/jetstream/assets/search.js b/docs/jetstream/assets/search.js
index 4d8ff976..72f17236 100644
--- a/docs/jetstream/assets/search.js
+++ b/docs/jetstream/assets/search.js
@@ -1 +1 @@
-window.searchData = "eJy1nVuT4zaS779L12uHR7hQF795POOzPjue8bG9uw8Oh0JdxeqmrZJkXdzdMzHf/RAASSUSf4BJqfbF7hLBzCSYuOUvAf7rzXH/8fTmy5//9ea3Zvf05kull2/f7DYv9Zsv3/zf+vzj+VhvXr46NH89HvfHN2/fXI7b9srjdnM61ac/JSW++HB+2bbFugJt0Tf/ftvLrpQeZD/ud6fz8fJ4Fkt9iG8hGt6+OWyO9e4MTb6q13OtrCUWPNVy1b7s3TpP5835cpJqHUrfoHdmr+9xM+31PbTl6678dM3QgUbU/y+4zq1+k1bkaqGqq/Kv3u2P53/svmtOp2b3/of6tL8cH69+dP58aK3AhYoPqGb66iYbd/96v1u/BAnr42Q9DyUZuA4yj1aoi8fH/WV3/lvz0pxP3DR6Tf7kL5tP683jb+tDvXtqjRgV+pDekHm4yNaC9nefz/WprazfL82xfpIZkNxzpw3OYy8v9XG8Uh948Ts1v9Qv++Nnmdqh7J06T23D3LxPfBsrvRa+W6tr7sIavha+R6uvr/VVXvAbgQXZG++wpqvIG8wp3DnNnrQ/+e37/bZ5TP2v+73YjyTSnv5oTsCZu5/lfdLT5rwpCXnoCmQevjcjI93/VJLeFRBLz9XDf+YVuUvT6pbPKDp5kllg9PTRJAwIKc+80PQjenP16fHYHM7NfldUEpe7TVc7Y1qPPg0pJNYC6v77tvkl77L7WV73W9ceS1Ie+hJZW4MhGfn75+dTXVYwFLlNw3l/3myLCvoSYvm52v6hHdzrU+5puqvyui/WDZUmraLevvyT/Hlzfvzw9Wa7fdfOl5jm6NqknuDPaa/y57HeJKqJdwUBD+9KfZ9XXbCsHXOevr+cPnzdTY/+4Rs4H+ByxSbVwtfb/Ym3fP/biBSySHssinjoL+OqCPpLknkdc9H5ak5lg2eH4id4Qd7GJ7mRJW/4ens5nevjt7vnfaJluDKh76w3TzUf/rikh6FUzuirTRk9/n8jWroyN+s41od2crXhDSPRQ8pN0ZW8if3LYVu7NtYuMS9b3gnyy/J30g6uElkPoVzmEbhxpefw/cWfwaSZXprWj4QbM700uzqhdcnlPZCyuSqKbRx9mu/q06kdojKV1F+9pZ5wjx5fvEVu6kfh55tkffX9txlx7RX5+LB5SrpHJuYhFCm+NW9NRsNT3Xp+0ttwJUOpm/U0oA/mWroyN+vYNslcLdHRlblZx2FzSUdsrqQvdLOWY+1KjKkZSt2s57I7NHyVlKjpC92u5dAulkefZig1TQ9uf31H9U3u6a4Fbmrf7f+fGx6pjC/eJvdYt5VQ7OLiMvLx4FA/bXbn5lEs9YHcUX4nsdXjT/kX353kurbu6l3xBCSrHFbgtk2OLkCVkiCDULPTIlHZlZuqK/eu0OSZXJrANx5/Wz9v90n8KJH2QEuWH6M0w30ME9NRbddyd+gqdQdEVV/sDk2+qeWaDlE1lLtdVzvqN3/UKRBJtdGSt+tD655EVXnhI9FyeSnQJqAwKX+f7il6X0tn+2bE7zItf5/uj5vmLH3ea9nbdfrJV/sEL5tmJ9Gblr9T93gVD8Xu0HQ5fVi/c2GscW206O0aO+ojaqRx2dt1JoQ5VXUuhCawhtxIB1gJvSRftTWn7y/b7ciychD50JwObfHHa/Hy0/wnj4Ayzdegpkjz6cPtmnE9lpf+x3vW/se/78/fFJy+vzxl7njZ5RaNkbSHvmS5jgYDp49xsTpR2xnTFtqhSN9Q9D6NhVlqrE80TQXaCp7RPDePm8LMnBa5yfu+b3a7bPceLso9rxEIemjG++zOqOnvg+oRvY1EU66eck1/rM2Tnux9AspiIQ/vC3zsakdeeoKARtX5IXRSh1nS35f55rh/Kayxrup7rc/tDaJIWUn7pAe/45mxf/yXiyjlW1J/Wd6WCl4eCZP5+WCe4El80KoYDaJFJvU6f6nfXbhQ/9tdkZGrhHI8JGifHAUh4iWxj6IW8FaJ+OKr5HLTunXxj827bZ1pBWkBed8FY+oZgWOhdWBo8ancog3mU0XXJvqhv/Mz6KXopSmRID+XWn/YnD6MCXxghbO1dDUxH6PJvGimcbSrk2jr1s+fvwbzy1RlX7o8x5yi90eXGrJLkofzqk/XG+7Qvner6HGdfbHbNeEoSqpqLIIi0ZWPnqT6JJETiU44c0/Vjcza5ZrE/tJlxb6Gt5ybl/p03rwc/r7Z7fmcMdU8FN91xSdpTnu19kn2n13Pmmgerkzp8/1NI6IersVyxl+tKtjeHOvHs8/fgnn4yfUJmVnuJpG4h75o5kkSG6flKWSUjmYqiPUOOfwyxbT4nZp39adzK2t9urz7Vaac3TFdf8GDMGxMC0ybM1xv//G8OZ7b7iWvoC9xl4afmiSwgorcoONvm9P5mwRbRddukPrd6f1/+EwxXPPXy7fJxqmr/PINsrs9YEl+C7s6aaX/52ynE8vzq3BBr3O1Ma/Tvbk+FJl7u6n2Vun5pbvruQAo5XZ0Ngj1vwylp+vlb/P0uDkmE5rw64TxwnWJf6ufU0+7CnrwhbahUM7uYE2ur+6qfExRX+4eXWjVSXWU152J7Ey94zUavTapbf7102Pdzjyf4HQgvnhX9ACIKocRmGGT4wlIoSSwINML3jVSWHzlWU3pOzq0rTN9Of7XCRmvo2IerkVyJofrRVv3x3P9lImO8MsTffVcH3eb7Y9oiRNfnBBTODTjkh5CqVylRGaV19cCXdeSE/Xx+vqmbkc8lHF8vTCp/v1tGUgXXZsuFc8l6aVpMrf7j62LtSsivuGHXLkrSszllJs6tSdvdTtvO57f1Rs+Ug2/T9hx0E43+jaWWaHHUh/cHX0Aa3SRfrW0oP/HUnwAaBcGCEZ1g7fFtBXfFZKffVMnt/89ie7wy/dRZShthConBt5QV5E6WZWl2njNffu0rXN+Hl2bwkO39fqDWOZDUh4/VGxp4Yl2z/sCD+CXJ2SDpGFzKKyc/p6Yl3+S60EdIXTern2TKSEsM6lvpseBfN3OAPMauus3Sy/b312fMH9yW21l8h6GsvilpFbm2ifYs5pRWd68WtKYrcOvt02ddEfs6qSZ1vfH+rn5JBDoJlyHvvDIE3VWjtCb7IujWmnhu7Ti8yKgzrHTIvIaeUQAT6Kg0rb0fih9l95f627g/m6za+d+vPuD2od7XoZ77rLhcHm3bRIkCFVfi07XmGklIw/eXZ4yBxjxWCpxisv2huZWKD4EJFI6FL1P40griVSKm0mqk+2M86dYNPlxJ1IbFb9Pc9vmukETAHGsvb2lw9jFMX6CBSN9BNcu7iRGNA8tXqSYlr5Bb7mdymrgllXnIGNExeQdWKMjZ7T7asLQme68GqfyWOkImZdqdKh2f8l2QpHKa9nJOrNv7vswPIy8wLjUpAhcoYcFUh+GO0Yekdmd0f8BcqOiAddbXsWCl9P7b/8yRX97QyGVdaL2Y30udfxI//WWV7FgxL+RBWI3z1qQ9fb/AgApvviKs5arvClzlmBilu6A8+eQwpHD52Ta8MlzSN3YsXNSfcXZUaRPODfi+sqeUTqxsVBy2ph5wjB7+H2itO9OPLXL/yb3Y3B+21VC+fC2oH1a33sVPdrTlqSDWBERXZ48luTmM9iIeEnqWlHLKUnyINLDxVukXt79CoZbInkocIP0c5o2QkR3V2+U65PVysL7IvdoQNlzSE05bY7rildbSXoWUVDKxhqT+tWI4Jtl/3pKUDKR3F29Qe5uUzA4XLxFav2p4ODd1RvktiNKmiRLm05//QbZ5/qYLAOJ14WrN8j9uD/+VjT6WkAqPR5dupytbJJUcn0ar8tk9mGpD+wO/ESpxYWna8CpB+FHObP4eXP6vHv8tr1n086BfslLe/AFm65g/gGCUXLvpyqK7g8ks/rY9wjzL+mUIL44MetpXNZDOWGUmZZfa0lUdcUmauK19d3mE8o06H+W11AuuzaSJEiqHQwq2pzJZiBXpln+IpP3wMpmH2Gwr/AUp/dhrw/ulPjlSfPpbFd3Yybo39MG636S1/EeBmYGGQ9j8UpvgJyFXwUX+TeTip46W5PxRXlNFHLBgUhZIjgzVDxbRwpL0/asHlRzOBZHrkzzwP0P9emw34G1GL10V65jIqic6RiZNME3Ey1lH8VaeP384/jk1nF9tgCufFxowho7LBfXB5TLWhD+kNyInzXzEBlrnpttOxNYd6vBCc/6kN75GvZ0gYD1fredUjfsttewpNltHs9tha/PH4716cN+y4MAJXvgza9hlfvf+oB4SMmc+K7XsKMda9Yntz1knfaIJUv4fa9rC4hLyIwphiymWePO/t18nt68+X032jLSp/1Q47PQcsUmjMmbsbqPhZbPasmaLR8jytqL44VAe6aex09RzxecNJb/ox0Knrf7j981O/fRD7ixF5aRv9H3x/2FR+LyIh/64pkqhfbmVhPNrnDaXMGG9MbbrCnU9mhVv3Y931bJghoerd2kaidU6y11+tXuKbyQUZOGkq9dy7HgydV9fYJ7PRvbc4N/T7HsDqtex6Kcj2S60vjqpP7z+xqe0tr/PCE/xU/0SmIehiK4agZTcqusy/GYpqLGKq5lbtOx3fC3HssP12+TDWYGsfDiTGBM+v75edvsygquZcQ6En/Zbh7rF/Aa+t8nrJrhGbuxoNEDdq/25GZEmyQCylR0JeTykzo5Nvtjc/78f1wvmSiLLspr59Ddt34vlPqQ3pF5pNjcMf1wBl/UPzJ3n6gfp8sUDRhLl8lakHuzcMNtfHFar3t5lw7v4ccJERSUmUeEjOXjdUbkpF/8t1uSo6giBaTMLTrSNTOVXloZj8hFaaaR6HJmaSI9fX/bLR6LyZWJHnF8X//5c3rUxfWC3DNCTKos6GEolKuDwaAJby9WUX6DQH6uVmAWR3zxlWqHCJPWUGfcyFO0TpH6Svf7dE8JcdzkYyLRtelSfzo2Lzk7+2uvUc+RLFE1D5ZldP1W13xRAzR1pabpSWsqe/olvTSx9sfCJffGSX7wYTU4jtFLU2XCTTfD71NoQALFYikPXQn87q6WTI+nMz2iEPqovtORfyqFqQkF5NKzdY9TJ/nlie81/dKk/+2uKOhVQnmhE7TL45tEbjGYyeWmT31uC7YNK9NIoquT6rMd47LoN7omr9907E0FFYff2Kai7X4rPogR0EvTc8QBMEkEPrDC2Ue5mljKrYIhilRpXPZ2nd13DCTPGRWdpDF5X/1ZZXmPS0tM8LscX8pJfRCAJWRz6Ql9Yv1PaU9Arkxrn+19tfuO47E+ndJThPjl6bKf0oz04fe7stJjKeXM9KslxTGyrOFD+fukozpc28qcBsI0uZKj54CM6sORXKZqLGY7qgU08VhDsWGPSoerH65hJI99VAts05GKkTYskI9y2oGScl470jSWvc2UFDO4R+XDvGj+Osq50VgH7zlAEGPqyVZgHkaPmSpOxMDZUjT/futPoEqTNKMjs2ihW7S8Q+PXVf670qKgLDkcnY4PUGQncbXlxo5OLOsiX2woaCKfabhdz/gDCQ6CHNVSWAMzVaLPP5T1gX1NVElxY9Po+WjdgSi9n0I9w9V72QYSN0o4uIVTosFQ4UhYWKgv27MwbYIuBunKvKfk5Njhd/n+hPS7yLGQ4leRr3YU+5WygpHPNgh1lJo6UyVr8AWNz+6noqKuxI3y0y/2MPGlL/ZIpIsqS9w1TvtWNdMi6LCmfaeayS9+pXpUvvsfHtIHBX2RGzUcXKC1rKEvcqMG+M1opmLki9FYB+qT4Pd76KWJ68XuRj9iwm3XqIh8ZBrN582Kn5LNCx+jsGcmnwuUNye97yZb8BtA8a7hwg1v1N3WxTZwgD9X7AZdf882YX9lSrQHnT7ARY0ePUCtGrUdf6Mxvjg92hg+Mv7NptlmnoZ9rTHcFdJdn7u7ig83/cuNSLFgsnTDNxSRpmKoPKsJvzNcpXd9r4+KEIz943714/5yBCGn66U78y4SUbJpdmdWRlPdnfI8qosUvF1bvJNlVGdS/HbN2dZB9QnaRllLaa9Gqk62Q2OaXhhjyyseCbiNa+7ezfp83OzcFycyLZVqh7dMsqDU/rKj6vXynRmnUNxY5mliYq49uhNdRQr7kvfpS7NRsbZSVqpU10gbFGapSrVN8kzCyW7zzlFm5ouec2sGf0Xul2jnOhc0srmfWjTGUdFx4Ym6pPTNekNAAc/PiMJrsZs1PTfHU6GvvuqiBe/UlllsJcoKGz0FujxhFjwYKXefrvHHuha7XdM+E5mgavajsYmijszZCome0XMVBLp2l5e10NvjondpzGxBhipHNx0LdEr13agL97WFLx+nBSbMCLbb/cc1PMM4I/aB3VJ6tMjoogXH/XZ7Oaw/PCV5WWUz4vvuteWxkNGArYjvuF9/N+Zs81EsZAO/6147nurd53UhLJ/aEN/xKvrzQc+MekkIVKY993WsvPrxL2RN0A8/FZfVPZR+Jb3rXf1xfRhZ1mbtAHffbVe/Z2L9sb24/yg1KL3tXkt8/FTslNfSr6E3P0fGmiXTZanul9P79an555QHJ7e8kgVTHr54Otd0zTc0h8ytd1tUnzcwqy1jxbX43Zobt0CfNlXg99xrw26/To/GzCkfCt+ttZ03ujM22s5E6oPslnstOGS2kObU0/L36j5mtizkdNPy9+o++ViEtNKvpe/Wy4MmUgvAfa9ki7gSZIuOjOZk7RGk/dQ/D15/wEJ37WQpiCxva8kYLN5zUlJc2oAyqjet2cfWV5O3Gn6dwBtHxTxci+RMD9fztv7Uw2t0VmV8UW75QMThzAZIfUjvwA/EzBU8V+Y8y+T6LU+Xib9g2Q/wvpHHBKddmutDulNq4u05f2yOjfu23elPwzX5g3213Y4KcmvzrNnXouu1R6oZRX/95IbP5jyurb6WvE/l3/fkNIisut2+cB5EQRV9J+HzSJ//k+aIEYXk8oQ3Q2ZGBVnF88Oj0uXKoomFRXWFbwBPUNcno3z1GK3LS5r7uMjmsbgwv8GIv/k9HX/dtj1+LXqBgy1bf2c93PlqJv2/y/54efkbDShL7Pnd31aMMU8w5rvNp7+wDzaXjGjXSGNfbZ6g/If61G87igJXJQuO4Z7H6z2vZoZPhJlkRH/H3Sb8uNsc2pHhPKkqTt1Nr1kXgyHyyhjMeL3a8BPeCf1GSM56vV4jGDC9zwh2vHqPEcyZ2F8EW163t/ipPr40u420Os60+C3KyQDc9VLZiVF0/d7JUSqsOEGKi5er8G8b+P6Axu2m8NKmqvy+PvIDRkaVH+rjWBhsihl/rz/KdO/qfOR3ikK/5TbZiFlU7XOSRndkTjbiJ5oTNW5AMSdqRDltMj6I993pPT8+gVjAisgbzt/QJtcRwd6rxmuX3zriVpcXfkznmBm7y8tYPvVEIybXxGvXQhgi5Or74q+jPN+zYO1jvco09a51/Rjtuh0zYHwD7rgJUUPzIC0/NtHr8iaW6TATYeUOMypersh/bNG4DhSWdkWMKCTVRj/V/vX+qUYdVFJGXn39OivJth+TPiy1dvvzc3cnftb0/nIFD+Vbm/66czY8fbM/dh8VlNs3fDa4NbAOYp73x81jOe9tqrF/33dhqom1t9t3gbDXrTuWry82Z6ip/w1z/ue4370fGQqLdn10AkTDosBA2raSz00Sg0SfnIRtqe1mt623/ccTChfEcq8fPw33fHjKxwyud47PZAdT6t9FZrjKHUypf38tM7pMsAlGhBf+SiZ0TfPH5p+1yIA+Nt2Wfw313YzLh+tF+rv5lscAr2hAH0ifYkNfFa9hxg8+mU2kPeS9vZ7S/95sLzVevkLNf7jypVXsDerzE7+8CeMfI50y4w2576IX0LU/f8ONr4F0sJlTc6/aJ5ycK0EaQFyZa7AbRmZ+3enqQsX7a/FXUP59s9vVT19vmxpOgpABB3/LY3/LbUaQtwlPjryaID49Mnqub3ft0AcfKZH30Axl8bNEd4y8y2PzvqEb6kp699fCtyiOqxAf1hiplx/YOCXaAAXLog3JrTcv9LERr24ATeobVV5K55uqOBdhyKguRximKs8ONBntI4PMuPrIs/GhmdQI+cGZrIs418caRoSRzLabGMrnHiy+a2QiGyetjygfSVafpvp/9sff2pZxwc4MtH8kN9xogCkfsHg1QHrIYvRE3zRbiSy3p7h8xFxfemwF8LI/ImdMFL70JW9QaQQnSMaqxadISmY9UGB53pPcMtKzaLHak75D6ZycTnJyB+gnR4s9X3YeYJ7+FBcoViITC04si8UKz+4mYodgE5A4XJss7LvNrvU5ZCUvgkT/8vZNK7n+9ObLf71pp6LeG798o78wX6zaks9NvX1qC/4ctL51m4S61Nqn/ePF//OXrth/t6PE/ugKh9J/mr15+/PsbbX8otL6l1/e/tzf7C/4H3oZ11/8jar9S72tzBdW2ehGldyoohtbr/pZv7Xmi2W1im7UyY06utG0fxlkqkluNNGNtv3LIlNtcqONbqzavyqksUpurKIb57nKmSc3zqMbF+1fc6Rxkdy4iG5ctn8t0I3L5MZldGPrQT8v0Y2r5MZV7ADOH1bQA1LfUcx5vPdAv1PAf2IHUs4tlII3pz6kYidSzjWUhjenfqRiR1LOPRT0QZX6koqdSTkXURbenPqTih1KeY+CvqhSn1KxUynnKgq6lUr9SsWOpZy7qAV8z6lvqdi5lHMZBd1Lpf6lYgfTzmdU62GzL2aWdRWph+nYw7TzGQ09TKceplkX5fso2IA16KViD9Mm193o1MF07GDaZjvH1L907F/aeYxub67aJ2Y3p/6lY//SzmM09Gyd+peO/Us7j9HQs3XqXzr2L+08RkPP1ql/6di/tPMYPYeVnfqXjv3LOI/R0LNN6l8m9i/j/Qt6tkn9y8T+ZXTWbJP6l2HDoHMZvYKawUgYO5hxPmNmUHPqYSb2MFPlb049zMQeZpzPGNhrm9TDTOxhxvlMOzdHmlMPM7GHmWX+5tTDTOxhxvmMMagTMqmHmdjD7Cx7s009zMYeZlX+5tTDbOxh1vmMgU3Sph5mYw+zfqYFm6RNPcyyyZb3sPlbs/xCVSa+Gcy3Yg+z3sPgPMamHmZjD7Pew2CTtKmH2djDrPcw2Kps6mE29jDrfMbCwcamHmZjD7POZyxsGDb1MBt7WOV8xkLfrlIPq2IPq5zPWNjpV6mHVbGHVc5nLPSwKvWwKvawyo+RFTQ79bAq9rDKz+fhdKZKPaxiU3rnMxZ2+hWY1cceVjmfsUvUJKvUw6rYwyrnM3aFxucq9bAq9rDK+UwFu94q9bAq9rDK+UwFPaxKPayKPWzufKaCE+Z56mHz2MPmzmcq6GHz1MPmsYfNnc9UcCY1Tz1sHnvY3PlMBfuweeph89jD5s5nKuhh89TD5rGHzf2qEfZh89TD5mzh6Hymgn3YHKwdYw+bO5+pYB82Tz1sHnvY3M/D0NRznjrYPHawuZ+GwannPHWweexgC+cy89lbU32h5svo5kXqYIvYwRbOZebQtRepgy1iB1s4l5lD116kDraIHWzhXGYOh+dF6mCL2MEWzmXmsPNcpA62iB1s4VxmDl17kTrYInawhXOZOQ4xpA62YNGJRXZsX4AARexgC+czc9guFqmHLWIPWzifmcN2sUg9bBF72NJ7GGwXy9TDlrGHLZ3PLODYvkw9bBl72NL5zAK65zL1sGXsYUvnMwvonsvUw5axhy2dzyxgz7tMPWwZe9jS+cwCuucy9bBl7GFL5zML6J7L1MOWsYctnc8soHsuUw9bshiYD4LBsX0JwmCxhy2dzyyW8ObUw5axh62czyygh61SD1vFHrZyPrOEY/sq9bBV7GEr5zNLGKpYpR62ij1sZbLteZV62Cr2sJXzmSUcMVaph61iD1tV2U5/lXrYKvawlfOZJfTtVephq9jDVs5nltC3V6mHrWIPWzmfWULfXqUetmKR1lX+mUGwlUdbndMs52/t4ovKzKO7w7X4dvJbd7/3sgUar8I1fj8Lus68o+FQ3gyEXWcs7jpz3rOETSRc4/ez0OvMOdAKtpJwjd/Poq8z50MrHDWegfjrjAVgZ/Ps2wvX+P0sBjtznrTCgecZiMLOWBh25pxphWPPMxCInbFI7GyVm9+FS/x25n4+gI+neArF+5OAv8pXHwz5M/fzYfwVjp6jqD8P+/tIPl66KRT455F/H8xfwRWrQrF/Hvz38fwVjsGj8D+P//uQ/grOnhQiABwB+Kg+XnErBAE4BfCB/RVu/ogDcBDgY/sr3PwRCmAsQAUYMJtBBwQ4QDEeoHRAThhZAiSgGBNQPszfdmtYAAJPzAV9rB8PmAqgAcXYgPLx/rZfxOAL+CADBMrH/NuOET8BcEIGCZSP+7c9I7YAeCEDBcrH/tuuEQsAbshggfLx/7ZvxAKAHzJgoDwDaDtHLAA4IoMGyuQjbgpgA8W4gTLBDyHWUgAdKMYOlAn4E4+EAB8oxg+URwIqA1ABQlCMISiPBVQOogJHZBxBeTSgMiAVoATFWILyeEBlYCrACYrxBOURgVK4PwRIQTGmoDwmUBmoCrCCYlxBeVSgFPZkgBYUYwvK4wKVgasALyjGF5RHBkrhPhkgBsUYg/LYQDnIClwZYAbFOIOyAcbjPhmgBsVYg/L4oO1o8SMgJM880SMEhcGnAshBMeagbGFaCKiDYthBeZKgNO6TAXlQDD0oTxMUBqgK0AfF8IOy+Ykh4A+KAQhVFSaGAEEoxiBUVZgYAgqhGIZQVXBCCFMVIBGKoQhVmZIA4IQMR6gqOCFuyYBIKIYkVBWcELdkQCUUwxLKkwalcTIOIBOKoQnlaYMyOCEH0AnF8ITyxEFhvKsAoVAMUShPHZTBLRlQCsUwhfLkQRnckgGpUAxVKE8fFGamCtAKxXCF8gQi48kAWChGLJSHEApzVwWghWLUQs1DehIekwC4UIxcKA8jFOavCsALxeiFmhd6Q8AvFAMYah78ELcEwDAUgxjKgwkcDlOAYygGMtQ8H6NRAGUoxjLUInghHlMBzlCMZyiPKBRmyQogDcWYhvKYQmGerADWUIxrKI8qMKdUgGwohjaUpxXK4pYM6IZieEMtQqKcgS8REA7FEIfy1EJhNq0A5VAMcyhPLpTFLRGQDsVQh/L0AqcWKQA7FKMdygMMhRm3AsBDMeKhPMRQmHMrAD0Uox7Kg4xMuBFwD8XAh1oGN1xCNwLsQzH4oTzPaGcb+AmAHzIAojzTUBWenQIGohgEUZ5rKMzNFeAgioEQtZyXLAB+yGCI8nwj9xKAGzIeojziUBjeK4BEFGMiarkqvUXgh4yLKI86FM4AUACNKMZGlMcdqsJtGeARxfiIWumCHwFEohgjUR57qAovFQEmUYyTqFVwRNyYASpRjJWoVXBEPCwDXKIYL1GreaE3AMhEMWaiViFug6NvAJsoxk3UKngixGsKoBPF2InyOETh5AYF8Ili/ER7HtJO+mCiKQAomgEU7YGImuOsYEBQNCMo2hMRhfMNNEAomiEU7ZGImuMsXcBQNGMoembzb0EDiKIZRNEeiiicuKABRdGMomhPRXCPpgFF0Yyi6FlIZYeNUQOMohlG0R6LKJwAoQFH0Yyj6FmhS9SApGhGUrQKjghbswYoRTOUosPmiTl+i4ClaMZSdNhAgRMiNIApmsEUHTZR4Mx8AFM0gyk67KPINCVAUzSjKdrTETxH1YCmaEZTdNhOgWP5GuAUzXCKDlsqFjOYqg94imY8RXfbKhRsCQCoaAZUdNhascg8AvBDvrsiEJUFzGDSaIMF32HRERW81QFtskh2WXg/XGQEoI0WzA89IVE410Sj3RZ8u0VAKgu8gQBtueB7LgJSWeDGjLZd8H0XAaksIJjUaOsF33sRkMoCzm802n7B918EpLLEAyPagsH3YASksoTzZI22YTCkoj0iaRcAUABgKpoxFR2YCs4I0YCpaMZUdGAqOCtEA6aiGVPRgangzBANmIpmTEUHppLxA8BUNGMqOjCVJR7YAFPRjKnowFSWcJKoAVPRjKnowFRwiogGTEUzpqIDU8E5IhowFc2Yig5MBbM1DZiKZkxFB6aywm0BMBXNmIoOTAWnmWjAVDRjKjowFZwnogFT0Yyp6MBUcKKIBkxFM6aibckTAVPRjKnowFRwroYGTEUzpqILTEUDpqIZU9GBqaxwYwRMRTOmogNTwYhVA6aiGVPRdlWYHgCqohlV0VVwRNyaAVbRDKvoKjgiHpgAV9GMq+gqv08bUBXNqIr2kCTzDgFU0Qyq6ABVcMKJBlBFM6iiA1TBGScaQBXNoIr2jKRdBWIBwA0ZVNGekWiccaIBVNEMqmjPSHRmlgqgimZQRXtGonHGiAZQRTOooj0j0ZkpHoAqmkEVPQ/bcPF6DUAVzaCK9pBE44wRDaiKZlRFe0iiccaIBlRFM6qi5/kNbRpAFc2gip7nU101YCqaMRU9D36IWwKAKppBFT0PfohbAoAqmkEVHbaGKBjH1ICqaEZVdNgfonBLAFhFM6yiPSXROONEA6yiGVbRnpLkHgFgFc2wil6ELeEQSmiAVTTDKtpjEo1TVjTgKppxFe0xSfYRgCMyrqI9Jsm9BcBVNOMq2mOSbB0AT2RcRXtMovExBhpwFc24ig5cBWfdaABWNAMrehE8EU9yAVjRDKzoZfBE3BoBWNEMrOhl8ES8XgNkRTOyoj0oyfRHAKxoBla05yQ6czQCACuagRXtOYnOHI8AwIpmYEV7ToK3TmnAVTTjKtpjEo2zfjTgKppxFe05ic4cdwDAimZgRXtOojNHHgCwohlY0cuwYy5z7AHwQwZW9Cqk3eCWAMCKZmBFe06iMaPUAKxoBla05yQaZ61oAFY0Ays6gBUMFTQAK5qBFb0KjogHNgBWNAMrOoCVzDQdgBXNwIoOO1HwLBlwFc24ivaYROO8Gw24imZcRXtMonHejQZcRTOuoj0m0S7vBjRGwFU04yomcBVchwZwFcO4ivGYROPEHQO4imFcxXhMknkEA7iKYVzFeEyiceaPAVzFMK5iPCbROHPHAK5iGFcxHpNonLljAFcxjKuY2bxUB+B8DQZWzCx4IpwmGwBWDAMrZhY8EZ+IAsCKYWDFhA0qOHXGALBiGFgxYYuKxeeTALBiGFgxnpNoCwc2A8CKYWDFeE6icXK4AWDFMLBiVFisZCwAnsjIivGgROPcGQPIimFkxXhSoi1c8RmAVgxDK8aTEo1zZwxAK4ahFaPym4wNICuGkRXjQQlebxkAVgwDK8ZzEm3x6TwArBgGVowOfoibEgArhoEVE8BKpksFYMUwsGLC+VUWt0UAVgwDK8ZzEm1xWwRgxTCwYsJBVhUc2AwAK4aBFRNOs8LJNwaAFcPAigknWuHcFwPAimFgxYRTrXDqigFgxTCwYrqTrXBTAmDFMLBiwulWOPPEALBi+AFX4YQrnHli0BlX/JCrAFZgPN2gY674OVfhoCucuWLQUVfJWVfeESsYjDbwuCvmiIGrZHpUdOQVP/PKFOaIBh17xc+9ClwFk16Djr7iZ18FroJJr0HHX/HzrwJXwaTXoCOw+BlYgatgTGrQMViMq5jAVTCkNICrGMZVjMckeKJtAFYxDKsYm180G0BVDKMqxgY/xB0ioCqGURXjIYnG6UcGUBXDqIrxkETjnAkDqIphVMV4SqJx+pEBWMUwrGK6rSowAGUAVjEMqxhPSfAWbgOoimFUxYSTsmDWhwFQxTCoYsJWFZw/ZQBUMQyqmLBXBbcjwFQMYyom7FXBK14DqIphVMVU+QMbDKAqhlEVUwUvxCsdQFUMoyqmcHyWAVDFMKhiCidoGcBUDGMqJjCVTCsATMUwpmICU8Gn5xjAVAxjKsYjEnyOggFIxTCkYsI+lUwrAkjFMKRiPCHJtAJAVAwjKiYcq4VbIQAqhgEVE4AKzqAzAKgYBlTMPDghnhQAomIYUTHhhC08rwJExTCiYgJRwacJGUBUDCMqJhAVnEBnAFExjKiYeYHsGUBUDCMqxgMSPJwCnmIYTzGBp+BTjQzgKYbxFBN4Cj7ZyACeYhhPMYGn4NONDOAphvEUswj7A2AepgE8xTCeYgJPWeClMuAphvEUE3gKPibJAJ5iGE8xHo9kenOAUwzDKcbTkcxKF9AUw2iK8XAkW4XACxlNMYtCXwhgimEwxQSYgvP3DIAphsEUs1SFARXAFMNgilkGN8SdGaAphtEUE2gKTgA0gKYYRlPMMo+XDYAphsEU4+FIBtEbQFMMoykm0BSM6A2gKYbRFBNoCj46ywCaYhhNMYGm4OOzDKAphtEUsyxQPQNoimE0xQSagnMgDaAphtEUsypQPQNoimE0xawKCxQAUwyDKWZlCi8BwBTDYIoJMAVncRoAUwyDKSbAFJw/aABMMQymGA9HNE4DNYCmGEZTTKApOA3UAJpiGE0xgabgNFADaIphNMUEmoLTQA2gKYbRFDsLjgj7IwtoimU0xQaassRHKAOaYhlNsYGm4CxOC2iKZTTFBpqCszgtoCmW0RQbaApOwrSAplhGU2ygKTgJ0wKaYhlNsYGmrOD0zAKaYhlNsYGm4CRMC2iKZTTFBpqCcygtoCmW0RQbaArOgbSAplhGU2ygKTgD0QKaYhlNsYGm4AxEC2iKZTTFBpqCUwAtoCmW0RQbaApOAbSAplhGU2ygKfBsCwtgimUwxYZPfuBMCQtgimUwxXo2YnAOogUwxTKYYgNMmeGmAGiKZTTFejpiZrBTtgCnWIZTrCrkZFuAUyzDKdbTEYOTGC3AKZbhFOvpiJllDsMHjshwivV0xOBjryzAKZbhFOvpiMFJjBbgFMtwitXhsw24LQGcYhlOsTp8ugG3JYBTLMMpVgdPxG0J4BTLcIoNOCXTFgBOsQyn2IBTMJ21AKdYhlOspyMGf3XIApxiGU6xno4YfHCWBTjFMpxiw0dDMuMK4CmW8RTr8YjBeZAW8BTLeIoNPAUTagt4imU8xZoCYLaAp1jGU2z4iAhOIrSAp1jGU2z3IZGMAOCJjKfY8DERnIlpAU+xjKfY8EERnMZoAU+xjKfY8FERnMZoAU+x/Lsi4cMi+PAwiz4twr8tEvapwLm6RV8X4Z8XCTxFweWGRV8Y4Z8YCd8YwYePWfSVkeQzI75LxHFUC780whwxABXcnaCPjfCvjdjA9fCH5dAHR/gXRzqeAteMFn10hH91xIYP2+D+CH14hH95xAMSgxMpLfr4CCMq1gMSgxMpLSAqlhEV6wmJwYmUFiAVy5CK9YTE4ERKC5CKZUjFBqSCEyktYCqWMRVbBUfMfLQGOCJjKtYzEoMTKS2AKpZBFeshicF5kBZQFcuoivWQxOA0RAuoimVUxXpIYnAaogVUxTKqYqvwmSXsiQCrWIZVrKck+HxeC6iKZVTFekqS69AAVrEMq1iPSQxOY7SAq1jGVazHJCbzzSbAVSzjKjZsVDGZOgCOyLiK9ZzE4CxEC8CKZWDFek5iMt9vAmDFMrBi54VjOS0AK5aBFRvACs4XsQCsWAZW7Dw4YuYrUsARGVqxnpQYg3t1gFYsQyt2kU91sICsWEZWbDgADOebWEBWLCMrNpAVnC5iAVmxjKzYcAIYPtPSArJiGVmxi6rgyYCsWEZWbCArmS9yAbRiGVqx3QlgeJIJ2IplbMV6VII/6mABWrEMrViPSkzms2CArVjGVqxHJQYfw2YBW7GMrdiwUQXzMQvYimVsxYaNKvj7YhawFcvYig1HgOGDTixgK5axFRvYCj4IzgK4YhlcsZ6VGJzMagFcsQyu2GVwRNylArhiGVyxnpUYnExqAVyxDK5Yz0oMzgW1AK5YBlfsMnginl0AuGIZXLGelRicC2oBXLEMrljPSgzOBbUArlgGV2yAKzgX1AK6YhldseFDKTgX1AK6Yhldsd1WFbzgAnTFMrpiV2GSiJc7gK5YRleshyUGH6RmAV2xjK5YD0sM/qSaBXTFMrpiA13B+fkW0BXL6Ir1sMTgdFYL6IpldKWaBU+EjakCdKVidKUKdAVnx1eArlSMrlSBruD5SQXoSsXoSjUz+elFBehKxehK5WGJwZ+YqwBdqRhdqTwswfOTCsCVisGValbIh60AXKkYXKkCXMEJ+hWAKxWDK5VnJQYnc1YArlQMrlSelRiczFkBuFIxuFJ5VmLwd+sqAFcqBleqAFdwDlQF4ErF4EqlAm+GXWIF4ErF4EoVzgDDJ7FVAK5UDK5UAa7g7PYK0JWK0ZVKFbrECtCVitGVKtAVnA9aAbpSMbpSeViCPzhWAbhSMbhSeVaCmX0F2ErF2EoV2EquCoEfMrZShTPA8AmlFWAr/W+/vH3T7P6oj+f66dvdU/3pzZc///xm825/PK/3u/VLczo1u/frY33aX46P9Zu3/3qzbkK5xVuv+s2X/3qzbP/z73+/7RW6v94Oqvw1p9tL3e86mUjk/CpyIRP5+Li/7M7rD5vTBypoRYxzH9CZIGvbvDTnExW2vMpaCSX9Ru93kcVBgjv5zN/lgohCYevn7X5/jCpKk5rSUjmJXRW1y0jFHPbb5vFzLIlU97J/PiUUeG7+iLxAU3Fu276/0WX6iOQ9PVFhlsiqqk5U+IdA1B/NaX9s6sgd3Bm416dtZ7gTRMW1tqRyJon5rRURVxl9k/0LED7ldktFGWqWC/YHYXPh29xu9x/XT82xfjxHBq5IG3ApDnJhx/12ezmsPzwdT7HEikoU1t/2XB93m3P8Rt1ukEGU2+8hEnVoopepiQz3VYbuHQj7sUNTH49xG6cVFm6TNtFDc9i8r2MHoV2Q2CYv5lj/fqlP8dskLmKEjtFKO9bPzaeo0mzUcczCve7MYpHI0+fdY9O+0M05rjl3et/1aY2s1t5tzo/RGOI+LXU1TssczEt5bB33HetsqXtILeK13k5TiZtamRDWU5hIRt8fykS1w+PT4XL68LjfndpLx/3h3LT/jHsPIl72Gt99Zs3RZR6S19c1JZdkKBa3rZ/PceskA6YSVh16jZbIqXp/NbIx4HG7P0UDnSHCzKIf5uSy4hdLRiXTjZm2s1A4FD9uL6e2OUUTDSJ1YbpuaDmMo5PkNrvnfWQx7eFkk5jH/VM8VSCO0hnX+fS8m4aoWVcX7nNHoUQl1fVy2NbOw9up6mUb+ZOhY6TMzZ24VtCplRf3C2TS6zLvZLJ2z8376D2RulwI3bttuufj5ZF3nqShdFUpFtf+krRmSzocK3TuIAq2P2KelXXJnbSXtu7b4Sy2jXi31JeDNND1WfIKxC4WOtJIDBm7qq7FuW94TpG39iuZeMSmfY1wgB3EpWsiTVdYLt9zkrxT/Xs8OaGDo3CW0wtz64e4SRk6G7bTfO7IpnWWtM5K3q6cpN59nyPjKvJ659OeNG31FbFuPtG6Y91Og583zTZ+r3St6rY5TZcJmkZFnGU+TeZT3fbB8UhHZ+vzaQ2DD0Fz4imLaU7Ml2AL8i6W06za1pun+tg+6CN7UkOnLXZaf3dEHd6CVJ1w5dqL2+3Pz24CGEVGSN++6kYLxz8nym2em8cNb8VL0jdP7K8OzW4XV+SSePVq2sv5/bI/Xl7a6VY8AdDEPFtNq8o4ukT8xn3qPXT4S9X/o5sXuu9nTNJxbruf+qldNcdTLjrnWk7rMi67tGJXdLowm9a0L4entrtIe7UVnavPpG+LDXhLYtiqmxuqudA1fT8WPeecdNvSXvFyPNZsFKaxFb2UeU1bSZtogkbasO78xX2XI0zJhcvxp/rdJa50GtQSxmdC3xwNl+T5+hiIGmyrZC4cxG7ebWs0P6KBJPdteLnEOCCyjNZLMi8LcrqONV6a03WvHdZHYrHNH/FTKrpOV9PkrEGAdkWdRhj+7MSxhkBj9OL36eSkVtEInlLdws3l802Q+jlp+SsatlFiT/bC+PyALs6UmlRtn08ubraLAQd9DUoY832qd5/XaVPT9DmtuCG0sg6XI/NeapZVslnpU316PDYHPmzTGYvu2sG8X4KrfnirhsCEbAh64qEwGocxqg9SCwNrTtpxHzeQGX3TwghpJ8f1VLEs6tda2EiSkLn72h8Jjgod2YvxUch00dYOptSwyRLBzN59fP4qUlr/V5HtNOV4ZstB9z16IlPoIUzmuXmJX4qiA5ww4hmEbjenduobd8+KjkLCQGeQ9nJ6/8HP91k9Up/pg4FWuLwZJINYvfuyPZE85aW33l1vXjjoiGCfEfZhzelxc4wGEkVX6cqavkOQvhkvcL2rP64PLqJwefcraz9usyXp1aTvyMsFIyglKMr2L0gYa3vav2yaXdwW6QCvB/TRT/dXw6Sp69zMUjizuxy2bjkV9/AUP7jDkydJWn9sxew/xpVLYyzC8FR9jBcjdNQRS1gnMWDSsIWdbcLaNF3JGuHK2EuJWzEN3rlPCYvEfHqs66f6CfTXmooTBrLqTwc+kFBupGfCh/t0aPsAZg7tSXq/VJWs028Ftt7UxE2UrmWsELy2gvYuXQUtDtqRm5oo8/P6k4fCEQXXNJzjjoqZIij0m7FddFIqnH8/1+1gltIxithUJXMKLwoFhBRlUKqS9eZeGpoMUAalhPP45yaePRma21IJ57WtEAauNH0wd9R56ERnfW8qDKcEwWh4cScFEQ+R+W4sLo680gFBC5fKzzwPhMYpjNQ5muPpnMTkacjMnY4il8Sei8J4sxJ62Hb/sW3f7ex6GzsYHYSFKSnv6zgwRHuImepH2d5BFjIDW6FdvhhfMrovXJO0HrGNaf5BlB9kZa3JCeKYPnp6KnMma1ytTCRK04ZqhBSUyHo+7l945S3p+ngma1OtSDdD73u3ZKZORQpBeCsSBHncUY9EVN+T9HNBI+zwWuGo76QMTC178LcSv6LcG19Ro2e2N1rWoN8f95dDHMGkvVQP2fVC9f+QDblhBRTnYNHu1MgeGy2kaCRO9+1bC+MMncD1frf9HHfOVGrVv3FhqKSVejy/qzfxrMzQyZ0QBQ6STi6LNo7MKZqUoIQrxybGJMQkYZffPG3rNX5ASv6VkK45cZnqou1jIWtqzS5kl67PH9q57If9Nh4sZ1Gsatk3Y+GDs66Ltt/eQdSQMqP6kHCfhWKEo5dTkwuFK5oNoYR5wM3udN7s4mk45chWOEQ3u3Ymw2INhqLZSkgRmtPhst2i56MzrGX3eirhWtNJxR3igjST5aqXKrP11/oMJveU6at+4V4Jw7uDyG4+0b4dtgqksU4l7GCvUg+NWzAziXSevuhc0wrXq1R0spAmTV7WRKk08Oh0LiXEDYPEx21T71iXRFewwqneIC95WJqpM03Uy2bXTi7ixlzR7nLZDdRq2VG0Sk+sz04FmmrQ5q6EwaBB7m5/rneuR3pqZ1qdz8aImUaGptYxNJfO2IVZoIPAw+XdtjnB1SrtrJSw1xvkXpLZIU3B00IUHovL7kBpR3MiW5gk+OsJTo8ogVZ9zoZw+frr6eX0PhZH44rCxfqvpxgZKRpr0X0CpxGGln+r63iGauhEUpg+kOynoLNc2UC93UQ1oyNM36dzGOF60C1ookZFIyvuvBGpkDXYXkM7GqNlzd/LevfZRy6id0cxuhYmH3hhSbyBzkGEQUoviIcbaGLiTG7QkDhT/54kzdCdJktZy2YiExKsDO2Ehcl7HYnKgB6a4qmFOelO4qG1EOCTKD1buD5x4tDTun3SZHXXw55+/VgJIxFevO8v0VuiDrSUzRUigeAd0ZFHmLi4TZa2dKEnjHH7ISCuQNqbyGXEmzMoCKiEW6ba0TOyhPYe1zWT8P01fH+BomFGLVz282Q8TaNaVupL+/7VJwlWtCvSQlT8svm0dls1D/XuqdnFqVU0ANNXmKzyvdR4nmHoqtUK1y1OTkoSZtQy04dKhs0jwgXMIHvtOqWG5QvReJEwTdwJhKmSUa6B7C07WS/1C995GSUYTBAEAArNgNTC+KIXdnq/PjX/ZO+WDvPCGX8nLG7ps2hvzSSrTnmgTjsyLX8Bp3O7UmCzZboClQ1+QZLvq+M1HQVYUklg0xmdrwnTJFpBIHfP0FQBK9xX0orC7kVnokIIAByeciE968JTldT3vbz19QWAviQKZgqlpo+r6VuwQgDQC2obUzInoJNBYVZ+Ly7dQxj5rNDV6vOGjy+G5ppZ4XaXl2aXG1807Rd1n2ynhWnKTjAUSif2i353nTAG89K4WAnYB25oCpoVLj7aTinkP6JZL80W18JthK3AOPCtKMvSwhlEZhpOM6m1cL7H+29FZzTayBx3t2HHO9CggZZ5gy8fTRlpgka4adF1H32kU8+7C3rZMzHVE5KBkvVb2cyi38/bh7iMkHE5M9bpHnJNx0wtzGBw5eOOh+Y1G+FqZ1fHOVHRRL+vFCtsh7v6U+xHNE6tdVdrut+zrYWbmJ1YuHCPJmZm2D0rG/ic1Jz705FGmNblxKEIHU2/1sJNNrv9mu0ZNXQjv5U2hH03DiSbngyNx1vhJo7dfse2ftPkxL5l2VXVj8xSK4/16bDfJWE+uj1TC6cgu8tLboih8Ufh/i4nDe27oBMaOxM6cSsLWUXeqzDQ7CS1KxS4s4FMPaRv1UvzWZJs+k2nMcKkRCcMJgbRFYYVBpadsI+b5sxqbEEqX5hP2koCVW/iHfCyyt8/P2+bHUtMpfNbYRi6lXOKk3poZqLuCatsWGFQ2ET71YXTnbbvWvus8ySqSddhet6v/oUxxKtYns2u6VJMz/vosjDqBbtaaqhwcrs/um2rQyImFEsHMWE+JhPbTiHT/XiaziO1cLzuBI8cYaLpcNHOC4Sim/cNyyE1FFxVwpD2vu2XXPZbLIguKIWbYXtBLy4J4jc0w6edlBbmixCpcNFAp9HCJI1U5Gb3FKyOZUdHGAnfeCcbvWa6ZNVC9n3YXOIjXCrSNwvnnl5GO2y4HQG8eybShDnHXlq8EZ28A2GHeqifNrtz8xg9GWkFwkZwqNMd9ppuP9HCuQNwLTWLgn99jyfcHdQJ9GGLJEZARzLhNqtOXh8qSETS4V94bl3YW53mLBiaXWKFG1UP281j/cIk6eiUuH75ZYWb3Q7Hpu3kzp/XPicwbkrR6WLSKuzlpXttdEw7hPXXy3Nj5f7CnjyaH8j6pV4gel665BSGlXpx6HHpWDacoyBMzDhckqPG6GYDLVxdd3kScUyPNjnhnMXlcqHelu5n1lIvTjaq0nWIEUJTL+XdZz4zo9sotDDZsRcFdgNEx28JsbMX11YWqymaeC8MgXpJYSl4YpujaPa9cLnlpZ2PzUtqG42SCJcibrq1fsdX0QtSX8JzKHIJfZquRYww63BsEkjTTY0QlWYWlooSO9Ufz6mFYXK3vtzAXpKGkbWQwAZpQBhd9pgeU1phu4BrYBrolXlKKybthTTNJzNDxpIQgg8iQS6UptmFps/QrYSNt21tbA1K00SM+O06OFY/hrPmWIiIDvzCE8V6eX7FFEujkVzhnj138F288KR70oX7HY7tc+1cA0NeR/sT1SfjCpO2jq6PYhiKnleohZ1nOGCWz+FonoMVThmCpD8220vNT9WtooPrhC52FYdwLH0XVjjMn3Qc3Y8OwJO5LN+tv4hy5fr9y8Npi31I0/RnG5nr5F3WLbQKcaxZU7xnhLgcJfqYeCvyrPdDmf/0EpOlD11ZGCEvT1IC6DqsEg7gp93mcPqwP+NuJeqYJwoE/QpdPgl3toaT39nBsbS9CU/bPR0f4wqnk7DhQBnhGjETaaOnfRvhWqk/1QI4Gu2FhRll8DwLE42vwgX6ICnTnmiPYoRha5e0f4lfJREiFJHmh1Aep4Vzuk5OOVEh2gEwRWy7dGOeQacPYT7iyI2sbx+GfXQmLF3yGz3sUZH6cSv5iSVqa5rzb4TJoelWF5piuural9I9B171aNcOZwGqviuVurp/a5xC00MphevQThJf9dFh2AhRYL89Jz1nlI4awh3bnbD+HPp4dUtbjhB3wjNaNN2LYKR9fNg0kxzHpylmM+KephMWDrhMz4+ltM0Ig89BaDLM0gmIEQadr6K6fhCtAWk41gg3MAbB+RM9aRzECs916zbeJDkLi+j8cOH8ot/Ek3BtTZfkZtGPnkJMGORmDsuksRYrPJUApvrRHa59sonqN/Hp2bCJf0g2maQLpYDT7BIlzFfqxCWft9H0gytGyJipsGSNQtNFV9LB9iovbUq0VQoDuZ3AM+/N6AmcRhjM7DZDZQ4G1TS1ygpXiUHkx+N+9z63O8HQeaMVgpdWLkcUtPa0HlKghO85XeEp2gHp/sM6pv8igu2z8irhYSadivX5uNm5cxKiod3QLEIrnSFwiayDoiNHf5KtkToqzIWga95ZXxHCfUedxMHY1MMMBZhWmEFwujy2ixm2mqEeZfodtsKD4s6b94w3UKwqhPztBCPepUyPuNLC8JkT0uw4fDf0bB0rxJ7DFvx0Tm5UtENGaNogDyUSG3pKnRU2wUEksJASeGE+5iAOG0hXgsK9jsmhhnQGoPv4mZHal4IyRaMNarXsB1ZZ7+0EtuPAyyG2kYbk+oPujFn2nZisNxhk7za7PdvGQncA9GeOauGmh/P+zE/+ooH/boohnEfEnRUd7aWNlq0x6YatPizVB9T6M61U3w2qPjiubP9L1f8yH47A7i8NeeJ9YV0N+bx9yG4YcoTpEf6E8ChcTN698MCLMPhHQsj77Z/DCGMnH/fuoP54mKYTEy2MNDk57cThwpKjafaHZFv2L2/fHJpD7bPgvvz5l3//+/8DPhXvXQ==";
\ No newline at end of file
+window.searchData = "eJy1nduS4zayrt+l6rbCI5x08J3HM97Le9keb9uz1kWHQ8GSWNV0S6JMUu5uT8y77yBAUkDiB5mUaq7cLoGZIJg45ZdI/OuhKj/WD1+++9fDh+K0f/hSyPXTwyk75g9fPvzfvPm5qfLs+NW5+HtVldXD08OlOjx8+bA7ZHWd13+JSnzxvjkeHp76Ag9fPjz8+6mXbYQcZO/KU91Ul13DlvoYPuJpeHo4Z1V+amCVr+rlUgqtvRrsc75qW/ZunXWTNZeaq3UofYPehb5+x2ze53vMzkXelZ+vGRrQhPr/gOncajdxQ25WwlyVf/VcVs0/Tt8XdV2cXn/K6/JS7a521Hw+5/VfcKHRFxQLeTWTrH1+W562RydhW83W8zgmA7dB4tVG2mK3Ky+n5rviWDQ1rZr/G//Nj9mnbbb7sD3np31xep0U+hg/kHi5oK4j2p8/N3m9rfLfL0WV73kViJ65sw6txV6OeTXdqI+0+J2aj/mxrD7z1A5l79RZN2WVvUa2jZVeC9+tte3uzBa+Fr5Hq22v7VWesxtGDZIP3lGbriFvqM7Ik/PqE48nH34sD8Uutr/u76PjSCRt/0dRA2Pu/swfk/ZZk40JeewKJF6+r0ZCuv3TmPSuAFt6qh3+O62o/Wle29IVRSePswoM3j5YhAEh4ysvtPwIvlxe76ri3BTlaVRJWO42XXlVbSffxivE1gLa/sfsNZ6auj/z2/7Q9scxKY99iWRdXUUS8suXlzofVzAUuU1DUzbZYVRBX4ItP9XaP+W/X/I69Tbdr/y2H20bXxq3ifr6pd/kr1mze0802r/N6a2XE630VcRj/zOuqdOfkFxQc/bEFunhj8oMtz37EaHuxxuk7spj3G2CRjiOdZpYNvhKX+0+IAVf7T7MGqXtQ19nh8NzhgX2v82X+n1e19lr/g87ZtI1Ayhxr4b/LZr3P+XnA53Nx4rO0xnPjn+dmhUDC34eEfD4PDaHW9UjNSsvp/2Pl/r9190yP9HoiWKzWuHrQ1nTGcz+bUKK3z9GRTz2P+OmcPrHJNM2pqLTzRzLBu8Oxc+wgnQd9/xKjlnD14dL3eTVt6eXMtIy/DJjDZBn+5wu46ikx6FUqtLXOo3q2dbFKXJiJLQNZW/Waf8zoasrc7OOKntptq9VeTlPaQpK3q4vPx+KXUY7f6ztWu5mXfXnusmP22yHpv1IY1T6Zr1Nlb28FDuu4rj4HM1R/yqP50Pejpw/5fXlEGknP/N7Wl5F3QzJenTlEq9AKzf2HnYW+CvY0vs/zZsd3IOJFQX5dcaYyZf36JVNNVFYx8m36RYPiUbqf72lnfA8Hf54i9zYjtyfb5L11Y/fJsR99eO3/Fk/XmtTMaMrbr82CQ37/JA30XhOlQylbtZTgJmVaunK3KzjUEQ7yUhHV+ZmHefsEq/DqJK+0M1aqrwtMaVmKHWznsvpXFAfTqSmL3S7lvM+m7axodQ8Pbj/9QPVN6m3uxa4qX9/XZ5eCspRwh9vk1vlWTM+xIVl+PPBOd9np6bYsaU+ek+Mf5Ow1tNv+Tc7nKSGtu7Xu7ydSNa405PWbbbvE6rkuECZmlstHJVdubm6Ut8KbYm8n2bQ192H7cuhjLzbkbRHv+T4a4ytd3duYTqp7VruDl1jw4Gnqi92hybb1VJdx1M1lLtd1z4/FH/kMa6Ntfklb9eHdpaRqvGtJUfL5TjCwoHCqPx9uufofSudVc7/lnH5+3R/zIqG+77XsrfrtIuvbZUfs+LE0RuXv1P3dBMPxe7QdKnfb59b5+S0Nr/o7Ro7Js3qpGHZ23VG8S+xqmbEGYM1pGY6QHL9n/i7tqL+8XI4TGwrB5GPRX2+HA67a/Hxt/lv6tcmmq+uapbm+v3tmnE7jm/9q3v2/tUPZfPNiNH3P9/H3qC0CQwXVXD+HBeqY/WdKW2uH7L0DUXv0ziySg31sZapQNuIZRQvxS4bWZn7RW6yvh+L0yk5vLsf+ZYXsVkgaAzSkkrN/x6+HtbXiDSl2inV9af6vDeSvUYYPxTy+DpC76/1SEuPwN6kOjuFzhowx/T3Zb6pyuPIHuuqvtf6UpVHlqdsTPusF7/jnbF9/LP1KKV7Uv8zvy+NWHkgjGfnQ/UYb2KdVqPeIL/IrFHnb/nzhQq1f7vLM3KVMO4Pcdpne0E88Rzfx6gW8FU98aOfksqN27b1f2TPhzzRC+IC/LEL+tQTAqdc66Cio2/VbtpgtGfw20w7tE9+BqOU/9McT5BdS23fZzWNnIoEPpLCyVa6VjHto0l8aKJxcqjjaOv2z5+/BuvLWGVfenyNOUfvz23gWhwVkFZdXx+4Q3vZ7qKndfbFbteEvSixqikPCkdX2nsS6+N4Tjg64co9VjexaudrYttLF7P/FtbSFMe8brLj+YfsVNI1Y6x5KH7qis/SHI9qdVOVn9uRNdI8/DJnzLcPTYh6vBZLVf5aq5G6F1W+a2yQHjwlFP0+I94OhLNicY990cSbRHWcF6eQUDoZqcDWe+xPGPEU+8Xv1HzKPzXb58/b+vL8G085eWK+/hELwrAxLjBvzXB9/Ocmq5qf89/TCvoSd2n4pYgcK6jIDTq+y+rmmwhbBb/dIPX7+vW/bEQebvnrz7fJxoH19OcbZHcnVKP4FvLrrJ0+iqFH8uwunDHqXOuY1tl+ud4Vmfq6sfZDVjfH7qmXEUDJr0dXB6b+41B6vl76NetdVkULGvfXGfNFOyR+l7/ElnYV9GgLHVyhVL1dbVJjddfkU4r6cvfoQrtOX8f4vjOSnWh3vEfzf5vVN//+aZfn+3wPlwPhj3d5D4CocTcCqdhsfwJSyHEs8PSCb40Ujn7ypKb4G52LKlpudH+dEfE6KebxWiRVZff7aF3Lqsn3Ce8I/XmmrTZ5dcoOP6MtTvjjDJ/CuZiW9OhKpRolqNb4/pqh61pypj7aXt/kze49iji+/jCr/e1jCUgX/DZfKl5L+j/Nk3koP35dnpqqpMcRvV/u8hJTOeNd3a9Putb/lWdV85xndKYa/j7jHElWD6AgsUMPpT62TwyJC6Y26deajuj/ecw/ALQzHQSTusHXItpGvxWSn/xSdZudI/Lu0J/vo8pQ2gRVjip4Q1sF6nhNFmujLfft/pCn7Dz4bQ4PPeTb92yZj1F5/FJhTUfe6PRSjvAA+vOMaJDYbQ6FjYe/R9VLv8k1jZBznf/cZNGSEJaZNTb7yYq+LvfRTBL9frP08fp3v89YP7WJAHjyHoey+KPEtUz1T3CiPqFy/Gj9mMZkG359KPJoOCK/zlpp/VjlL8UnhsB2wXXuC0+8UVfLCXqT/HC+1unMPUytOJsN1DmVyyatkXoE8CIKKn3Nm3IofZfe3/Ju4v4+O2Wv0fAHtQ/PHIdn7qrD+fJ8KCIkCFVfi96lsW7dgsj7lPjE7TQy6n8a05vonRMN3v08Z+0x0VN8iXO6Sl/R1M7Iup5YSoei92mc6J2BSnb3jHWSE3k2t0+Rnu8CtUHx+zS/5k03WQMQj7W/5k2Hz0fXFjNqMDE2Ue3swWlC8zDSsBT7pW/QO95PeS1wy253kDGhYvbJr8kZOzj1NWPKjk98TUcDYKUTEQFcjS0iLi/JQShQeS07W2fyy/3opqWJDxiWmuX5GxlhgdTH4YmJVyT1Tuh/D3nVaAWuj7xJDY7167d/m6P/WL+OhNDO1F7lzdjAj/RfH3mTGtS79/n+EkUsjFbBe+ZN6jDRx1AV2F2NWYMmuZeC2hvGfiqpOdnX/wmwXfjjG67ZrvLmrNhcFZNMDeQkRQonEpLytOFspEjdVCpSrr7RtWGgj7kypPrGLWMsi+9IyXkrhhqHEAx/nynt+5oG1Nm/8e0Y5PS8ShhP6Om0z5t5rqIn55kx6cBD54keXzqPyU3HDXriOQGDo1rqKLTGk+5+vEXq5fk3sNjwJA8FbpDexME6nuju1xvl2hDBceF9kXs0oJhFpGY8WJHqCveaUVCcp2AsBm5KapwIMRR8s+zf6gjge5K7X2+Qe8pGKux+vEVq/mnEwLtfb5BbN1Ucmux3nf73G2Q3eRVtgj2rc7/eIPdjWX0YrfS1AFd6OLt0kXLJ0LTo93mUNBFPiaU+kifwG8U1Hnm7AuSacH/kk6J3Wf35tPu2yausKatf09IebcGiK5h+AVcpvvX7KkbNH0gm7VH24Phv8ZIg/HFmrNm0rMfxMF1StfROk6OqKzZTE22t77NPKL6j/zO/hVIxzYEkRijzUKHROidiSLxf5tX8yJP3SMomX2Go38hb1K/uhBUelOjPs9bTyaHuxvjbH+IO2/6J38YldEsNMh6nvLW2AvwIhKvg0agDIhW9dbIlwx/5LTESgQ9E8sLvSUXZq3WkcGzZntSDWg57Ir1f5llg+VNen8sT2Iv5P90VYRoJGo8vDao0wzYjLeM2irXQ9vlHtW/3cX2MBm58XGjGHtttF7dnFEE8IvwxehC/a+IlErV5KQ5Nm1XY7QZnvOtj/ORb1KdzBGzLU5TUfKwy5LG3qElxynZN8Ue+bd5Xef2+PFAnwFh94MNvUav2P9szokFj1Qmfeot6lOdma3n6Nh4Rx2pCn3vbugC/BK8yoy6LebVpc0xnn+d3b/rcjXWZGNN+ynEGulSxGXNyNtX2odDxDDnJavPniHHto/MFQ3uinadvJEgXnDWX/+OPvHo5lB+/L07tRVDwODUsw/+iKIF7WuTjeBZ3XN/UbqI4jeT4G6lD/OBttRlp7cmmfut2vq2RGS082bpR085o1lva9KvT3n2QySoNJd+6lUPBs5v7+gb3Wjauzw32Padmd9TqbWqUspHEUBr+Omv8/DGHuXH7P8+IzrELvTExj0MR3DRDVVK7rEtVxQHAoYprmdt0HDL61UP57vfbZIOVQSh8dCUwJb18eTkUp3EF1zJsHbG9VHVRN9/HO17vl3kWeMh2+RF82P7vM/bhMFdyKGgyUfK1Pqk1Vhb5VImKrgRfftQmVVFWRVP8me9xl48L3DcDJORNDPygmgmdZ1eSbgRSar3iN2hOtObn/9O+TKIlux/5rdhX0d3aw5D6GD8x+m59daf0wx3WqP6JvdVM/TiQarQCU4FUyRqkviw8hh7+OG9MujzHyy/3xxkeLhQ36gmZihbtKpGSfrF3OEUJ2gIFXplbdMQ+DV/6mOdiQi4Kgg5Ej8c9R9LB98MhRdcfZtrD4ZAYiK+/zJRYveZ//RwnlLn+wLc054McF/Q4FEq16VChGdYQqhi3CCA/1Sowaif88Y1axxPGbaGuchNv8Y9z5EYe/j7fUpzfPrqyJ/htvtRfquKYqmf/21u0cyCL1cxDzRK6PuR5tISJNXWl5umJWyqZY9b/aWbrT7nH7vWL/WTdqHBe9H+aKxMebRv+Pof+RBA0lPLYlcDf7lqT+fyE6GEhk0l9dUUvJCJqXAG+9GTb43mN/jzzu8a3Tdu/3eX1vkoY39g67Xx/tid31HlN5cZv3eSntmMlOknw66z2/Lk7qoB7NvmV38Z1eamizBVI2uNQErcMrV9K3znfpXLRY7Xkgbu0N1kVJ0+HaoeS9+mLTmNgZSOnMNKaIgvJf08GgwS/zbCOaHUWCxpdoIV1Gq27TYkCvIb+T/NPjQCEGgl8JIWTr3Kt4li0JXRaxkrDsrfr7O6T4bxnUHSWxuh79Tkj0xYXl5hhdyninJL6yEDNqM5jb2iP2vwSzxXeL/NG8Kas8vY+3SqvazD6kZ/ny97HZ1SGv991TiWUMn5W5VqT0VXUuIb347d/T+qwuZlwViaiyWZlmsrHNKkPsx2iaoriTGoBXTzUMNqxJ6XD/THVMHGyZVIL7NOBiok+zJCPTrkAJeMnXZCmqfMcRMnomY5J+fCkBP0c46clsA46cgC32dwMg2Cl7qf7G12qgxx//omcg80EGIdtB6kL/UK3aHlG89dV/vPYtnFcsrvCAieyJRkR8yafSmE7rsu7OWdEk3ddzu16pl+IkZB3UsuIl4SoYl3DM64PnHT0lYwedZzMU9klpurtFOoZfr2XTSJxk4SS1nAOf4AKJ0AEU19yZCHaGEMM0pX4TlEG7xtyd8f305OU1WO3009mx4b36BAFE9fnMHWMdXWiitfhRzS+FNH1hURRV+JG+WDzH4of3fMzpLMaiz00juhKjlaDFsaANSL/UCRmxEF+V+JG+e1/8JQ+KOiL3Kjh3LrixzX0RW7UcLG3l42rGMrM0YHGJHiPmv/TzP1i96CdMWEiBlSEPzNNRvgnxc+J74evkYrByz6NRAemqxM/d1Nd8Bf4u01ClEGXblSA3/rtrvZ7kA8oIdPugsfTAYHq3rL3TqtnbMJn1cBtVG+pSHfo5j9aHwyjZ1RreiN+R+3+Jztc7miyP7rH762Zc1f+kFoBxnVxDzCWggntuI8in/Twww2jbvtY539MwJxEsRt0/ZCcZu0vczyyKGcQFTWZMMiv1WTd8X3W4Y/zicDX9rjJN1lxSLwNudnaPeUOqbx0T42+3PxbrpFihhXfcN800jQKPJOa8DfDTXrX3ca+CMb6fNqufobI0/vpzmi8SBRvK9xVK6Ep727EmNTlFbxdW3j+dFJnVPx2zcne4etj9I1xLWMnLGN1vHOV8/RCP3ha8YRTfFpz9222TZWd2tu5Ej3V1w4fmVWDsf6XnFWvP995TgSKmzovElUx1R/b7PcshX3J+/TFZ0iwtrGzJFxdE32QebaEq22WZXos+zbrnOTatmiT2tfbX/h2ifLNUEETKXn8Gk3FOqCrVSJ1Uemb9TqnH16feQqvxW7W9FJU9chYfdXlF7xTW8IhEikbSc/A0GWjQBgv5pW7T9f0a12L3a6pTHgPfTXlpP9wVEciI1KkZzIbEkPX6XLcMq09LHqXxkTiEKhyMlUIQydX34268Fj7T+sgHfFu+gVmrAgOh/LjFt67kBD7SB4Ze7Wg0qM1qMrD4XLevt9H0bXj1Qifu7cuu5GoI1yL8In79XdzziHtaUZ1oE/dW499fvq8HUFncR3CJ95EfxpMJNRzMAVPe+om0bT66dtEZ+iH1+omdQ+l30jv9pR/3J4ntrXJeoCn765Xf5Ju+7E47cuP3ArFj91bE8s42EZ5Lf0WetNrZKyZs1zm6j7Wr9u6+HPOi3uPvFEN5rz8aE7N+Zpv6A6JR++uUd5kMPI0UYtr8bs1F8mtPNBbMHbzfK3zFij0mXvrcCq3cRrtlPKh8N1aL8dtm4+r2GVcyyeP3FuDcyI5REq9X/5e3VXiuFtKt1/+Xt3uBA+30a+l79bbuWrcMmp7zKoPebUFZ2NSNRl5/q3qNriRZtbJf+6N6sL+QLxtWEJztBtz0n7p3wfvyGChGbwExNmmRY4f10xUONW20VnKMcVjBysn9cYtu9vldfRV3V9nENhJMY/XIqmqu9/Tdf2lD7lBObfDH/k1H+J44FoPSH2Mn8AvRKrLeK9EXu7o91veLuGRwrIf4XMTrwmydqvrS7bZ9sJjp39kVdHejFz/ZfiN/2JfHQ6TglpvRbLa16LbrYXMCUV//9RO7UUzrS2/lrxP5Q+ll9Uqqe5UjuS1GlHlfxN3yeXn//YjWz2F3s8zvoy3ahuRNXoPSlB6vLH8cOhRdefiLdT1IXRf7QJPxZjm3lOU7UZdFTdU4jt7Eu3vh3zn+345dTnYJ/PhyTer0v+7lNXl+J3vYufU53f72KjXfUZlvs8+/c3lzGZV4ph92g/F71b+U173hyUDV95YDSr3zO76zJtVw4YGzapE/8TdVfj5lJ3r92Uzqynq7qG3bIuhIvzGGKrxdq1hF7wzxg0XrvZ2o4arwPwxw9XjzUcMV52Z44Wry9uOFr/k1bE4ZdzmaPzityj3JuBulEoujILf710cxcJGF0hh8fEmbG9c4mk8ZCMfba7KH/OKxipPKj/n1ZRjcE41fsg/8nSf8rQvfI5CmyggihwfVW2jtCZDxmdX4hc/Smy6AqNRYhPK/S5jHYzf1680LZBXA1KE33G+Q8cDJgTzDghEj06Y1eVI041PVeN0OU6dAplZidkt8dat4KYIvvq++NsoT48sWPvUqDJPfdu7fg5yBUxVYDptwHQVgo5m0WJ6bvJ/53exxIAZCRsfMIPi4w35jwOa14HCsbNcEwq9ZhuuCP7qXHxd7nM0QEVl+M3X77Oi8wdT0oet1qlsXron8bvGz4838FD+h7L5+6mtw/6bsuouR+bX77e86Y7IlE3uxLyUVbYbjwScW9kfys5NNbP1TmXnCHvbtiMnGNjVGVrqP1Gd/63K0+vEVDhar4+tANa0yKig37eia7O9CrGuzoZ96ecmOxzy/X/tkbsglHu9xN09836f9hlcn5xeyQ5VyX9nVaNt3KEq+e9vVY0uNm5GJbozVW9Tha5r/lz8mbMq0Pumiz/zt1Dfrbisu56lv1tvWQzwhhXoHelz6tA3xVtU4ycb3sfS7iIB306pPdyJt69Qsz3NObaLvUF9euGXrsL0pepzVrzuNADrA3T9zz5w42fwBlh018VVNfe+i9AX0d54zBDmrkZO1t8vPt6Ef8tfsssBfb5I5X4oeoNSv9lwUn5PMz8xP4cEAXHjOIg8MLFg7i7XYSour8XfQPmPxemU778+FDlcO6IKnO0ju/6Rt6jE9a4Nbh2CJ26rgm9QcTZ/Tz8voz+lmNZx+12XeyGx2CGiW6RpHxtSMIwNMd7Dk0h1qExyrTFWlYnlxm0VCbMM3FCpMM/Af7qC3f/eXc/uf9+0um4Wm1c1N5G9STW69dMvv3zH0N8tnMYCtviK+T3r7XpTn4OZobS+Fn0jpeS4+rTqiUTdsyvwS5g0e7oCE7mz51eAZWWD9hvNzJsb4D0HV83suw6Ct/n2VDcZnHEjeY/FUBa/R/DExFKjKl4LP3HAmN7yWvgWxWET4qsFAvX86wXmMAQomMcQokdvdt/jSrx5BfzDC5PKx44tzFWc4gYJ1ePcYK7y5PYxoX1i6zitPrBsfMWDXwn+NQ9kiGjyKoecF8l8LK7lUy8WPjXhngoP500onziUN0/1/5bVh98v+QUbM9D+0Xvgxgoo/yhqnOz9WgFuwvfgjb4p4HqBympzp4ynu+5LTy3IjmWFjDFSeOxL3qCSNBnMZh+qZme052zKocDxbXn0yMTIItlqa3mH0uVVZVG3171FaY5fLicbllT/JSww2ohELMieHIpl3jTliR0QEpA4/DZb2PfZKXuFtaRFkOhfnx6K0z7/9PDlvx7+aP1J5enhywf5hfpi8/D08FLkh3398OU7p/WpPQzdHebZl7uL/eevXbH/yXdNWbWFXem/LB6e3i2ezOYLrVa//vr0rn/Y/mD/0Mu4/sU+KB6e3okno79Qch08KKIHRfCgfHh6J5+0/mK1UsGDMnpQBg+qh6d3ClVVRQ+q4EH98PROo6rq6EEdPGgent4ZpNFED5rgwWWqcZbRg8vgwdXD07sl0riKHlwFD64fnt6t0IPr6MF18ODm4endGj24iR7chAbQ2sMGWkBsO4IYj7UeaHcC2E9oQKI1CyHgw7ENidCIRGsaQsKHYzsSoSGJ1jwEtEER25IIjUm0JiI0fDi2JxEalLAWBW1RxDYlQqMSrakIaFYitisRGpZozUWs4HeObUuExiVakxHQvERsXyI0MNnajNg8mcUXm6UOh4rYwmRoYbK1GQktTMYWJskQZcco2IElGKVCC5MqNdzI2MBkaGBSJwfH2L5kaF+ytRgpn/TyC61Jc8X2JUP7kq3FSGjZMrYvGdqXbC1GQsuWsX3J0L5kazESWraM7UuG9iVbi5FL2NixfcnQvlRrMRJatortS4X2pax9QctWsX2p0L6UTFZbxfalyDTYmoyEA68CM2FoYKq1GbVAfUrFFqZCC1OtzSjYLVRsYSq0MNXajJJQc2xhKrQw1dqMwpN/bGEqtDDV2oyC5qliC1OhhanWZhQ0TxVbmAotTLc2o+DAq2ML06GF6dZmFJzTdWxhOrQw3dqMWsNFT2xhOrQwrdIPxxamyWLLWtgGVhust0IL063N6AXUHFuYDi1ML9MPxxamQwvTrc1ogcxTxxamQwvT6/TDsYXp0ML0Jv1wbGE6tDDT2oyGyxkTW5gJLcy0NqNhrzKxhZnQwkxrMxr2KhNbmAktzNg50jypzReLZfipTGxhJrQwY9fzsFeZ2MIMWdJbC4O9yoBVfWhhxloYHPRNbGEmtDBjLQx2DBNbmAktzLQ2Y+ByxsQWZkILM63NGLhgNrGFmdDClq3NGGhhy9jClqGFLVubMdDClrGFLUMLW7Y2Y+BKahlb2DK0sGVrMwaO28vYwpahhS1bmzHQwpaxhS1DC1vaXSNcVixjC1uSjWNrMwZa2BLsHUMLW66SU+wytrBlaGFLa2Fwtb2MLWwZWtiytZnlAq09l7GFLUMLW7U2s4TLilVsYavQwlatzSyhea5iC1uFFrZqbWYJzXMVW9gqtLBVazNLOACuYgtbhRa2am1maeA7xxa2Ci1s1drMErsJYgtbhRa2am1mCQfAVWxhK+KesP4JaJ4r4KEILWzV2swSDoCr2MJWoYWtWptZwQFwFVvYKrSw9SK1rVrHBrYODWwtktuqdWxg69DA1q3JrMSTWn6xWBPNsYGtQwNbtyazgqa9jg1sHRrYujWZFTTtdWxg69DA1q3JrDQaC9axga1DA1u3JrOCI+86NrB1aGDr1mRW0LTXsYGtiQ/MOsGwFwy4wUIDW2+SS5J1bGDr0MA2rc2ssBsttrBNaGGb1mZWsF9sYgvbhBa2aW1mDfvFJrawTWhhm9Zm1nBhsIktbBNa2Ka1mTU0z01sYZvQwjatzayheW5iC9uEFrZpbWYNR95NbGGb0MI2rc2soXluYgvbhBa2aW1mDc1zE1vYhnharasVmucGOFupt7U1mjXclLnfwse9v3XPt3azTvhrgc91QZyui9Z0NthluwBu1wXxuy5a69lgYrAAntcFcb0u0p4L9xt9nnhfFybZv91v9HnigF20ZrSBk4j7jT5PfLCLVXIqcL/R54kbdtEa0wb7nhfAEbsgnthFa08b7H5eAF/sgtif9eBj549ADv/I4y/S7w99/sT+rB9/Y570+gttBHke2B/1+1tX/mYJ7Qd5/qnr33rzN7D3CuT8p95/69DfYFc48v9TAGB9+hvcfxECoAzAQYBFgrkAA6QcwLr2Ux8QGCBFAY4FLDC3QTSA4ADheMACsxtABARBAsIxAdiDARMQBAoIRwXgSlAALCAIFxDW159oQIAGBGEDwvr7xQIPAYAPCAIIhPX54y2eAIhAEEYgrNtfLOCOXABMIAgnENLZIMZYABUIwgqEdf+LBUZZABcIwguERQB4cy4AMRAEGQjlbBAPA4AaCIINhHLkE48DgBwIgg6EpQFisYFmCOiBIPhAWCIgBPSTCkAQBEEIwlIBIfBUACiCIBhBWDKQmEoBSBCEJAgLB0QK4gI7JDRBWEAgWpCL3gDYISEKwkICkYC5ACoIQhWEBQUiAXQBWBCELAgLC0QC6gK4IAhdEBYYYIwkAF8QBDAInfbOCYAYBGEMQjszXMHRCGAGQTiD0M4M8YoYoAZBWIOw+EAIuPESADcIwhuERQgCQ2YBkIMgzEFYjCAknhIBdhCEOwiLEoTEPQGgB0HYg7A4QUjcEwB+EIQ/CIsUBIa/AiAIQRiEsFhBYAAsAIYQhEMIixaExD0BoAhBWIQwLiQEj+kARwjCI4RFDKKFwcCUAZIQhEkIixlEojMCLCEIlxAWNQiFLRGgCUHYhLC4QShsiQBPCMInhBlZHQJCIQiiEJY6iNZ5jZoAGCLBFMKSB4EZsQCkQhBUIZbp1SFgFYLACrEcWR0CXCEIrxDLkdUhIBaCIAuxdLFJeEAG1EIQbCEsiUgKAEZI0IVYOiNMBCmhKCVihEtnhLgnA4IhCMIQlkoIhZd3gGIIgjHE0lkhXp0BkiEIyhArZ4V4TgE0QxCcISyhEBr3ZEA0BEEawlIKoXFPBlRDEKwhLKkQmCkLQDYEQRvC0oqEJQO4IQjdECsXKId7MgAcghAOYaGFwGxaAMghCOUQFlwIjS0ZgA5BSIdYjYyGgHUIAjuE5RcCM24BeIcgwENYiJHwlgHmIQj0EOsRbw3AHoJwD7F2VojnVIA+BGEfYu2sEPdEgD8E4R/CIg2BebsACEQQBiIs1sBMUwAKIggGEWsXsol7MiAhgqAQYemGMHifBWiIIDhEWMIhMLsXgIgIgkSEpRwC83sBqIggWERs0iF2AoARQciIsLBDGNyTARwRhI4ICzyEgaBVAEAiCCERFnok3I6AkQgCSYTlHsIsoRkBTiIIKBGWfYiEywKwEkFgidg4O8SrU8BLBAEmYuPsEPckwEwEgSbCchCxxD0BcBNBwInYbMZeAQUS00jiRfIrSgBPJIEn0sIQsYSTqgT0RBJ6IhcybQYS4BNJ8Im0OETgQAcJ+Ikk/ERaHiJwsIMEAEUSgCIXI4YoAUGRhKBIS0TEEodGA4QiCUKRCxfHjmOFAUORhKHIhTNEOK1KAFEkgShysUkPJxJQFEkoihSLtPdOAowiCUaR7uTEEn8FwFEk4SjSnZ7AMRwSgBRJQIp0JyhwHIcEJEUSkiLdKYoVdEBKgFIkQSnSnaRY4d4IWIokLEW60xQ4tEICmCIJTJEOpqyg20QCmCIJTJHuVEXqMwJLJDRFOpqywp0J0BRJD1c4moLjNCQ6X0EPWFg8khhT0RGL6IyFNcQVDt6HxyyIIVo+InC8h0RnLehhCzkyN0t04IKeuJDOEHFfQocu6KkLR1RW0PEj0cELevLCERUc/yHR4Qt6+sIRFXzIBp2/oAcw5GakM6MzGISoSAtI8DJbAqAiCVCRDqhgGiEBUJEEqEgHVNYCnroBQEUSoCIdUFlL2BMAUJEEqEgHVNZ4NAFARRKgIi0gEWsYsCUBUZGEqMiOqCRqAOyQEBXpiMoaT4yAqEhCVKQjKji0RgKiIglRkY6orPGICoiKJERFOqKyxp0ZEBVJiIq0hESscV8CSEUSpCItIhEb3JcAU5GEqUjHVDZ4YgRMRRKmIh1T2eCJETAVSZiKdEwFh6lIwFQkYSrSMRUcpyIBU5GEqUjHVDZ4XgNMRRKmIh1T2WBLBExFEqYiHVNJ2QGwRMJUpGMqONZEAqYiCVORjqlsIBqTgKlIwlSkYyobvMYDTEUSpiItIpE42kQCpiIJU5GOqWA8KAFTkYSpSItIJA43kYCpSMJUpEUkEoebSMBUJGEq0iISieM1JGAqkjAVaRmJXOC+AKCKJFBFmjFLBFBFEqgiLSOROGBDAqgiCVSRy7QfUQKqIglVkY6q4IAPCbCKJFhFLlWaEkvAVSThKtJxlcTyAHAVSbiKXDpDxL0ZcBVJuIpcOkPEExPgKpJwFWkxCT5VDKiKJFRFLtPObAmgiiRQRVpGIhd4MAFQRRKoIi0jkThdgARQRRKoIi0jkThlgARQRRKoIlfuQDikkxJAFUmgirSMRCYWWACqSAJVpIUkEkecSEBVJKEq0kISKfAKDVAVSaiKtJBECrxfA1RFEqoiLSSRAncEQFUkoSrSUhKJ0wlIgFUkwSpylY7xl4CqSEJVpKUkiZ4AqIokVEW6syQ44kQCrCIJVpFrB5lxTwBYRRKsIi0lkVLAvQrAKpJgFWkpiZS4JwCsIglWkWuXpgDPioCrSMJVpMUkyVcAdki4irSYRErsOgFcRRKuIi0mkamcBShpAbFDi0mSrwAMkXAV6bhK4isAsCIJWJEbMdIGAKxIAlbkxlkinpgBWJEErMiNs0Q8GgCyIglZkRtniXhmB2RFErIiN84ScW8EZEUSsiI3LmkG3q8BsiIJWZEWlCTGIwBWJAEr0nISiaN2JAArkoAVaTmJxFE3EoAVScCKsqBEKjivKUBWFCEryoISfNRMAbCiCFhRlpPIRHYHAFYUASvKchKZyPAAwIoiYEUtdLozKwBWFAErynISicNeFAArioAVtXB2CLuSAmBFEbCiLCeROOxFAbCiCFhRC2eIsCspAFYUASvKchKJw14UACuKgBVlOYnUODkJACuKgBVlOYnEYS8KgBVFwIoSI4HZCoAVRcCKspxE4rgXBcCKImBFiZGtigJgRRGwokQ6MFsBrqIIV1EWk0gNZxUFuIoiXEUJl0kId0bAVRThKspiEokDZxTgKopwFSWcIUK/gwJcRRGuohxXSXwEwFUU4SrKnVLBkS8KgBVFwIpy51QSrwDAiiJgRUlniLg3A7CiCFhRLo0VDn1RAKwoAlaUy2WFU1YoAFYUASvK5bNKtQGwRAJWlMtphWNnFAArioAV1eW1wr0ZkBVFyIpyua1w7IsCZEXR9FYuvxWG1QpluKIprlyOK4PzVKEsVzTNlctzhUMGFMp0FaW6Uul9t4LZroglKmeJcJGoUMYrmvJKOUtMpNsClkjTXllSInHwi0KZr2jqK5VeJCqU/Ipmv1Jp941C+a9oAizlcqzhmRXlwCJgRVlOInHoigJgRRGwotxRFRy6ogBYUQSsKO3yreGuBMCKImBFWU4iceSJAmBFEbCiHFjBuF4BsKIIWFGWk0gcuqIAWFEErCgHVhLzEgArioAVZTmJxJlDFAArioAVZTmJxJEnCoAVRcCK0s4S8bwEwIoiYEUZF46I+yIAK4qAFWU5icSRJwqAFUXAirKcROLIEwXAiiJgRTmwgiNPFAArioAVZTmJTFgiACuKgBXlwAoOHFEArCgCVpQ7rAKhhAJcRRGuohxXwUlCFOAqinAV5bjKagV3bICrKMJVlOMq+AilAlxFEa6ilmOLRMBVFOEqainSMQcKgBVFwIpaynTMgQJgRRGwohxYwTEHCoAVRcCK6sAKXhwAsKIIWFHuwArG5QqAFUXAilqmUzoowFUU4SpqOTIzA7CiCFhRS2eHeEAEZEURsqIcWcGpYxQgK4qQFeXIyho3ISAripAV5cgKTiGjAFlRhKwod1wFn51TgKwoQlaUBSU4L4ICYEURsKJcJi4Yf6QAV1GEqyjHVXAeHAW4iiJcRVlMkvCAAayiCFZR7rBKwu8AsIoiWEVZSpIwY0BVFKEqylISiZP5KIBVFMEqyh1WwalhAVZRBKsoS0lwXgMFqIoiVEU5qpLoBYCqKEJVlKMqOCORAlRFEaqiLCTByUkUgCqKQBW1NiO9CEAVRaCKsowk0QsAU1GEqSiLSBJ7BIBUFEEqyiEVnJZJAaSiCFJRDqng+DEFkIoiSEVZQoIz8ilAVBQhKsoRFZzeSQGioghRUY6o4PgzBYiKIkRFbUYYswJERRGioiwgwSMp4CmK8BTleMoaz0aApyjCU5TjKTjHlAI8RRGeojarkYUdACqKABXlgAoOoFMAqCgCVJQDKjiATgGgoghQ0Q6o4AA6DYCKJkBFL1xeBzgWaUBUNCEq2hEVHECnAVHRhKhoR1RwAJ0GREUToqIdUcHxbxoQFU2Iiu6OqsDAbg2IiiZERTuiggPoNCAqmhAV7YgKDqDTgKhoQlT0Ij0pawBUNAEq2vIR7PXRgKdowlO0O6iSaELAUzThKdriETylaYBTNMEp2tIRhSMINcApmuAU7c6p4HWRBjhFE5yihcs4BwcDDXCKJjhFWzyicAShBjxFE56iLR5JGAHAKZrgFO1wCo750QCnaIJTtMMpOOZHA5yiCU7Rlo6oBZyTNMApmuAULd1BZjycAZyiCU7RDqfgMAENcIomOEVLZ4h4PAQ4RROcoh1OwWECGuAUTXCKtnQkYQaApmhCU7Q0Ix8B0BRNaIq2cEThKEwNaIomNEW7YyqJ8RTQFE1oirZwROEgSg1oiiY0RUtniHB1pQFN0YSmaOUMEY/ogKZoQlO0hSMKRzFqQFM0oSnawhGFoxg1oCma0BRt4YjCebM0oCma0BTtbg/BFyBpQFM0oSm6u0EE92ZAUzShKdrdIoLzZmlAUzShKdrdJILzZmmAUzTBKdrdJoIvRNKAp2jCU7S7UQRHMWrAUzS9VMTdKoKjCDW6V4ReLOJuFsFRhBrdLUIvF3G3i+C8VRrdL0IvGHE3jOC8VRrdMRJdMmItEUcRanjPCLFEi0cUzlul0V0j9LIRvUzm+9HouhF630iX+wtutzS6coTeOWLpiMJRiBpdO0LvHbF0ROEQPo2uHiE4RRvnt8GDMsApmuAU7c6p4EMeGuAUTXCKNs4QcV8COEUTnKKNM0TclwBO0QSnaEtHFM68pQFO0QSnaEtHFI7h0wCnaIJTtMUjSuG+BHiKJjxFG3e5Eu5LgKdowlO0xSMKx+BpwFM04Sna4hGFY/A04Cma8BS9HAlD1ICnaMJT9HIk1EEDnqIJT9EWj6jEXU+Ap2jCU7TFIypx3xPgKZrwFL10loj7AuApmvAUvTQjMxvgKZrwFL10log7EwAqmgAV7Q6q4HgRDYiKJkRFO6KCwz00ICqaEBVtAYlKXSIFLJEQFW0BSUoAICqaEBVtAYnC+bs0ICqaEBVtAYnCgYwaEBVNiIq2hEThOEQNkIomSEVbRKJw/i0NmIomTEW7DGDYDABS0QSpaItIlMb7XsBUNGEq2iIShcMINWAqmjAVbRmJwvFnGkAVTaCKdlAFOtQ1YCqaMBW9XqQPZGsAVTSBKtpCkkQuPQ2oiiZURa+dHeLxCFAVTaiKXjs7xMMJoCqaUBVtKYnCYYgaYBVNsIq2lEThMEQNsIomWEVbTKJwFKEGXEUTrqItJ1E4ilADsKIJWNGWkygcRagBWNEErGjLSRS+SUsDsKIJWNEWlCh8m5YGZEUTsqItKFEGz4yArGhCVrQFJQrfqqUBWdGErGgLShTOgKUBWdGErGiXBQxnTteArWjCVrRFJakRDbAVTdiKtqhE4TBEDdiKJmxFW1SicAosDdiKJmxFW1SiljCWUwO2oglb0RaVKBwGqAFb0YStGItKFA4DNICtGMJWjEsDhrMlG8BWDGErxrEVDKgMYCuGsBVjUYnCgYgGsBVD2Ipx16gs4ULXALZiCFsxi/QZAQPQiiFoxbgsYDhyyQC0YghaMS4LGA48MgCtGIJWjMsChg89GcBWDGErZrFJW7IBcMUQuGLcXSo4lNIAuGIIXDEuCxhODWkAXTGErhh3m0rieWCHBK4Y4ewQX4UJ4IohcMU4uIJjOQ2AK4bAFWNZSQLRGQBXDIErxsIShYNBDaArhtAV0yUBgx4cA+iKIXTFWFiicDSpAXTFELpiHF3B0aQG0BVD6IpxdAVfE2cAXTGErhgLS9QqcQ0sMERCV4yjKzia1AC6YghdMRaWKBwNagBdMYSuGEtLFE4jZgBeMQSvGIdXcBifAXjFELxiHF7BYXwG4BVD8IqxtEThLGAG4BVD8Ipxh1USQyLAK4bgFePwCo4DNACvGIJXjMMrOIzOALxiCF4x7rAKPgBoAF4xBK8Yh1fwls0AvGIIXjEOr+A4OAPwiiF4xTi8gsPIDMArhuAV4/AKjqIyAK8YgleMGjnAZwBeMQSvGIdXcBiWAXjFELxiHF7BYVQG4BVD8IpxeAWHURmAVwzBK8bhFRzGZABeMQSvGIdXcBiTAXjFELxiHF7BUUgG4BVD8IpxeAVHIRmAVwzBK6Y7roIXugCvGIJXjMMrOIzJALxiCF4xFpcoHMZkAF8xhK8Yi0sUDmMygK8YwleMO66Cj88ZwFcM4SvG8RUcB2UAXzH0bnfHV3AclEHXu9P73d1xFXx4zaAr3ukd72Zsv4Kueaf3vDu+kthuoKve6V3vjq/ge/MMuu49uu99ZL8Cb3wnhmjG9ivo1nd67bs7roJjYw26+Z1e/e7wCo4lM+j2d3r9u6UlGodSGXQDPMErxtISjSOhDMArhuAV4/BKYjwBeMUQvGIsLdE4lMoAvGIIXjHuuArONmsAXjEEr5jlyLkpA/CKIXjFOLySWF8AvGIIXjGWlmicT84AvGIIXjGWluArZA2gK4bQFWNhCb5C1gC4YghcMe52FZwA3AC4YghcMe52FZwH3gC40v/t16eH4vRHXjX5/tvTPv/08OW7dw/Zc1k12/K0PRZ1XZxet1Vel5dqlz88/ethW7hyqyer+uHLfz2sH77817///dQrbP/vaVBlf2t1W6nlqZOJRC6vIlc8kbtdeTk12/dZ/d4X1N6DOIhqbzqcIexQHIum9qWtr7I2TEkfgtqszVVCm97VPtViBaaw7cuhLKug8ZXX+porJ6rX0q8Xt5U+nMtDsfscSPKMQay791sZpsCm+CMwgzYk8Vqvje7kScGTt9/7wpS8ylJL98yy+wSK+wn2fxR1WRV5YBbtlQPXai7UHFFh63mvK5gW1on5UJyCt5XCq5LsPwRT5uEQNJz2rLbFgE7YhvlVD4fy43ZfVPmuCaSKjSdVM9vfCqvKw+Fy3r7fV3X4gRe+RKaRHJq8OmVN+EXbA4eesTA7xLkIPqby+8Ky7wxrZr3ORV5VYV/X3uu5xyTT1s7FOXvNQwPxpEnmINuJqfLfL3kdfE2/oyr2G56r/KX4FDSaMX4X6Ay3vSKCJbL+fNoFJrH2ukHrT2FLKZq8ypqw/duEx9c20zyreM6aXTAlSc/ulXJPCaa1WmFk8Fbeh2QO3VbMLjscnqksr/UVr7WsrGNe19lrXp6bojyFndJrMmYnBxI/Fs37Kj8fgtHS71/c9qNmu/I/xpL5xmSoVZ7t636o5XXM5/Jy2p8v9ftdeaovx7xCLRiMkzyxn8l41oaVXy3XiH4i5fV7K+6QvzTh8OaNtu1dmRxJyOaMZ79L2fcHyZN3KOtgxaD9KcB0r8msWysr+LBa+PNeP3730x9T6KVu8nDF5r3vuqtim7LP/WPFrayVW5xeyqDG3kLE8HrbrtyHay7PULrRt5ts3Brp6UHIrrLt/Z6uxJJnSO2vRbgK8Javii3kfMjbblLl9eUQiDPe5ze8sbAVV+V1XZSncDHhf3yuOZanl+I1+NjegLpmftryVDfVZUcnH6+3dYtXtrjLMY+GBON96CXXVKwo2Im977jkjcWdtG6gD+vmtdqSN5J20sD4abwZaMkbP/vROBDjzTZL0/cE5ijQydvafWVgZgt/EmPuTwdx8Q61PS/gme2stqu2df57MBQs/VUdc73TC2t3c6RLaX+iXLO7lBMXLq6NJ2o5qyNUvfm+BJVb+i4H3s5mEBj1+qX3UbkDei+syrMmf8mKQ7gh2firgAV3pPRlgq7hf9/VPJn7/JA34XS58gZf5k6zl0bnsZVnxet5Rkw3wmvvW2zm1eqQZ/u8yg/5jrxpG3DpWfK8CqIBb+OvpRbzesapbF7aZWQgz58tFt0mow1QmSm4eCl2Ge3HG+ULnzcqnIvTKWzLjfalzftAv1/K6nI8lOGiXvmrAM10ivUiw8/ib0ZFvzbddO3Z3oDp/sF0SA06muxwyPfv98EE0wa5XBcvYl67Xk5xy4qFb1ViXv++nPdZk8dDm1j4psV0UoFpz59YunZd9P9gOuPcsBYOQd4ovma+8KWq8rB20t+iS6afa581Wbjl8n2CvaF0uwfF3C/t8+cLaX5vZBSS11D7/CUjC+U2iuRqbIorpx3zg2nYe8newyVkv6lhurqc2Oz5kKN1l1j4w43k9WYwO7Xnmr2VFs9wnZxuxA79Xb4Frxb9G/NG2H1+KP4gr+l7EQTTE9HJ2cZ++PYmGM+9x/6+rTjSpXy8wxuUOjmADiz8wV4OnmT2R23Ffo5GE+EvogXfmK00uvQQC3/QZ3pIemF16xk9hSxL+IYnmM7RfX76vI37W3ua11vec9vt9Hl7vlSvRJTvTtbMQS6vd1VxpisCf9PR9/517yTo6YPonTua6ZDZU2edvwVr0yB33h3uJ6qbqgzNUfifmunv7OS0w1Uoyzdtph82piLt/dnetME0FivGuk3jHaEQPgFlumA9iWDbIPy5TXBN5yqybrKqIXtN4cMbwbUQIrMpjuFH8Z04QjMNxQo9ZHXzQjwwvpkL5nbYSTvWr+/tZiJsR783C+dRfHows776sX4FOEb4nVswPYFOYN1UeXakLEv6PcVwK1jvsipckvorK2F6By37y1iB21P+cXtu3RWX598oVfQrqtnfyMoF85XPjIUZPhBTbHnMilM4Ffiv349g7f3lbvnQbzHUqvc2C97ecn85H9qdWrhG0b5zda6k7cfitC8/ho3rwxymBzyvQjeav8lhS9hGXmrv1SRvsIhwqvJnei15SzcrJezFvu9TrJnv9GmX5/t8D8Zr3yUumJ7Z/NM5mkj8/Qfz4zsx+b4d/I71axFtUf04EcP01/tC6/z3SOTKF8nrWYFINwj0K69I/NoXz/04SfHd/0ZavMY2zDm21+IGXCrR9wgZJt3MP52LioA/nw6LZb/DXvLm7PxTOxgQYqP9QYDpNcw/ncs2sgxu8HzoLJjO3PyTDdsI41R810SbaG6OIPcVwnr5CyfmKvMlb3bvY/zqM1zB3I1ZUchZKHzIKVY827DS0FrOh5xixRsEX4oDoa6+N2HJFkLIaHsXjTdhddOt6jcQijnQO8FwdeDXs80kOF9c6JUX/mqd+yVopNY6CODgjdQvRVU3lNcof3mhmftgJ4lQJN97oJlb1pdD+XFXnpqqPIQG5q+hVrzXe82D7+bH3QjRuV/Vuo8HFLwKvuZNF9kZ7fmX/nJiwRs5XvMmiu0R/gpJGF5HaAXROJDg7X3vBnNYe80bJEr68VCKabCerJeqPNLG80NLBLNPveZ2g9WPbtFGy39jwzYZ4KcTfmCaMLpfX/dDyppdXzR2+g4Jsel2M3LBlpn84v50IZZ9pZkNUZWXc+id8UepdU8v1sv+H/1AyzR8t5MNw6g8s2+vEuGLCRvUR4hS9EGOTGdtJ3Bbng7EF+q7p4ZPr3jN+T7PquY5z8LVtb+1EkxePEiq28h3wmr8VZVg0tMidHD7XbsPUBC8SaDYH/Jt4k39DsScnVpxCWlBfDhvfCxOLjJ828YA1u/LAwl09sfuVT85bJg1JYPZ0jPAZdcvRB+lJVW/UV/1AwkzpqdVkwQcPkwWTFxZnOomI0zNnyUNc3denJq8Is4j5Q8/hhlGVdTny+GA3s/fgYkemRrmeroVi8dIf8sl+vA5wwzV/i1vwIJ/6YdEL5a9SF5LDiK7NUbdZGRj72NpwTScq9Rz0fpAiER/7b7ufEaGuRzyRUe+Ea+qvBHElwZe3V8DMinSIHF3KHICfPyYUbGZ+b7Ry3r7T95IPog6ZqfslXRnExzi6KxIbHrnIXP3R1Wg5cfSP03EjAka5J7KJj+1Y9L+paw6mw1GAT84yDAdSIN0WF0/ep7pQx0Eni/Ph6KGO1i/opIZ4zLIvUQrRj9kUzIJeygueX5M+MdKpGQaWw1XSr57ryephhnk8Vt9rMOwAh9nSyb0/K0OKaDwXXlS9atKZszlhzwPV63+mKGYVYpOQQXrSZaIQxa0jPRDVWTfnTXz4E27yQk7lb+x3vDmgFbIFhyO8z28ijnfW1nPn603I4xW8ec+Jn6zwqgPwneJaMXrjVYQdUH4rhrmWr2VMwRZxa5mP6rQMEOXiMiY7mt/KmIGe3ZwMcHu/Pg6yaSrg8c+sBDfiaxmWNs5r5D3zGfTbeo6rjjUbtKPK1Gmj4va9IuYRbdNM0wnitVjh2D04b0WNcwhPRAIPrvvtGZ6wQFPCD+Xv4Pb8CbINKMIRfuDKTMMFoj+IztcSJ39gJQFs2kjB4K/nWbSZSdkWxekFf3+yLWdgpxK8SEyMyY/nuy1H35pmKzzUISDgd/lrlFmTHMr6NEj4Qe0SiZ1j8Jr/Q23VrzZvRXielMcJ+mvGpihCsfs07Y9Dn/OT/viFEzYwbawH1V4lbRSaZSUfz5jRu1iBhQcjde9F653SWqm2Q+yt+3UUVQ05Nd3HLIFwuBnfyJnrqpbWcf8SE+1+5s/3kTuBMXoSy6CSDPejGaF1a/buviTfFs/IpQ5VnTCyKEbn7sw/dW9oGQkiwqOMvItuG7Kiu5pgjijGZLs9BfOe747nSsp6gzSHxslv8VA4KzynSCa6c8/Zp+wefmecsOUFRu87w6XPb40zJNsTt72+gHAWBIQc6bU+HWV/zW14r6uE1T8GcVarIKplzn8dOLi48X+8MNECp2wpgnjAvx1lWEe5TzmTUanKuXXSXPNozilpioZxM32OFNumLNMccJC/Z1c7xSUTCfZsYiipPwYOM0dcq0YlPXDj27S3M9av7pQaJR4wj8eIPkCw52S8M/eSO7AhiKk/IW2YZ6/xPtA6QfLS6Ybnk5NwvflS+Ycd8pIdiDfa8WMbrLl/dWw72TtFj89eBSLHrCsNr259ol5+iRJakjVs+pP4C/6f4jBK8Ob29p6bOPcI1IEKVH4ssI5xM/xpJi+7lMeBlr6CYX0pntPwzwdd8o/hUOpj0qk7s/s9/HGkrk1acVC11GQtUj3oxhztmulpuzfn0WZQUWtOOAjlv4JEcmMfjuVW5oexY+m08wueSq7aSk6pal8D55hLsxO5SlcxfpIVfedw6hh1cF92Sqvz+WJOpqlf3pFMqPzTpdjas7zPeDMia6Vhg50+asgrfg1Q7XyPgRzpmwlVTk8MuU70zdMu7XSbOh1uETzgyM1t6dejjBcTflHQTQzfLcV9jErGtJifiARk7WfLkfQ9MqnWIaZPK18eTkUJxIR7k/hTO9Z+fJSh6FmfgCXHCIQecIOpHf7kc3MQIzy3GztUZYoF4Nv7XLVn5xgAp+rWHpERvo2IYfkbszjx3Co9SvKjF8vq/ag/RAeDMX6kxiTyROxVQ6ODEt/+pIr5ns7wROZm2RwBph5GrasiteCRjb7PjLD9EKVf+RVG5MZCFr7jlYmVekFHdtAnA9wy+Hv5plRPZ5UKNJf1jN39bHI7LR3tQ5lB+5d5hfvZKPPHI4ZvNc/Z5cwc5W/5GMGZloZ2ypvjxnR4dmTxvR+WmnhPOZ9A+Yp+HO+z05NESTh81c5zP51zuOcINJ3xUrmnANMSwRO0j4Dn2LOrZ1A65KJ/B/+TMY8T9TJ690gkUg/posJnVt6V9TNMToy5XsbhngUJt9w6SXiUBzlR68bJg04H7JdfiSSZJALrA8U08wZ5FwVZVU0xZ9kkbgO9p1MI77KQt09SJLIXLB0IsO4VP+AiWJGDfeCtjbMl1TMT9fEjAca5IEcAv6pFcUM2BnktQuN8hJ+Yf/gimLuZnuB6H19hLzgbQB6ceB1/ZMwqmdHhnn64XyhKdGkf/BBMWnM+fIMon2kDzVV7+4wzD1PFzoVOpB9TMZE+W2AJ+oPvmtHMRekUToC6R8tVMxTlFbK82e6VPZjqRVzJduLAuzcj4BWTLe2FVeeyXEhP9JXcUfzVpLbm4cLBunHkyqm68tKa6riGNXNxyiKGZrWrn+3z9St4c8IzKCTVJCv9M/WKu5UNbEq94NHFfNsQZW9NNvoZIUOIq55grDLQAS0tU+JJJmDT+s5yOAQ7kNnyQxTcdKAMD8to+pj4Q3zkD3ybuhgW8MVEw9n0s/xqFSf3paZiHIQiUZef6BU/bEKw4T1VR55F/w+yxy/2/j8ssq7vKeh888PktTMmPJent0Lh9J8OMOMMmmTsIYuBf8wHfNAaZU3+antqcDq/BAY1UeVGibpqdrBjsBTPwxQMvGpSzkfrc59+2WOwE6SDaSiefZ936hhDsGeOBRE4Ds2DfP8bC3DMCbfZcB0ANe79/n+QjLk+FF4UvSBfswkRr1ENKD7W2fF5FO9vPjuEeWHtBlm/GUvrskqcnZV+ZG1hhlZO4ijJNvfzTDjt2iiHd9zK4ccJH1qANWfulN90jql+wOIzK1Ynf+eIDr+CQDFbVkQKal8QabPG2iYcSS9xMjB4DtsFbd1aVCRfxzWMBcF9Sk71+/LBg/xPnNieqsGgWCM94ECc50ddxLpD/KKmZ/CiSF8w0cSTMhXn/MdzEwq/RNcihnpUVe7cMb3l/v9SkwzD5YlnOz+lKOYFN6Kik+Y+ysIwcQcfcIt0JH8GZ8ZFwxTbSm/6Q0zEHiQlBgvVsGRVqaRNVlzCW3ME8IUEUfQ+VO9ZG7dOjnjoVzBud85YpvPZ2Jk/ov2MRaGuQgelpggF770A7tUH7FqmAd7rOQ9OXAkfV+pYq794yObfrSN6E9sin6ZrkT/j2XvMlkMK/g5Krc0msX3KjK9J50k6qvwT7wrJtnpz5lGCdb9bZBm0vVOWH8NUuiT8Yct5il3mD9O+ihBMY+3d6c/oxTE0j9nppi4fhDmMntH0frSD3JSTIjTnSe1iZyyeF3qx90oJkBxIqOlib/w08wE4VdR3diK1s6b4H4e7rjWCk5nR/fTYuhZ34f2M+kvnjUzMeJVFHlVv1rMXBfDWdkoeEf6Cz09nBZnxg46uan85b7kWaZIooT9uaW/PU/2J6tkf6+LXgzRBHOGDHgsKoz1Z252nLh4I+YHiWvmEQRfWJSlzT+QwzxR6sujvVL5EZqaea6sE9jQdbkf7aa5O3V35jiRql35kQ2amfvOifxYlafX1NE95c9ZhulAqZuKclj/dKLsL85SzHg14OwQ/nQlB7DbX1Jkhj7KDGLuVHSxZ9tjVn3Iqy3dkge3kDGDHnvJTZWd2uRHx1Ci/9m4iywqMVwB+z4c3SdW00wXEw4l819b9ZG48z7eUFlgu8GtZ1yv02W3y+uwnsGFYH1GF81MwlB/rpu8DWWMsiP4TIhpTk32SvClv6pmzumxf0n68XOKGXHe5KHNCf+IhJwhpDjReCrle8w1M0xjyOwTb5CUj1E10598lQfPvfg4VTMDvQeRoIbBPXG8RcogDlfQ76/MvF9R8mt/zS17R4Zi+lgAvhe+f0yKPo6cCVhbgXWTHc9hHf2Q+2Hftuw3r8wghkH2KTuV5BCjf/StP0wgmSuTpmzCQDwZRBy4pwRzo9VU2ctLsYOjie+lZ75yeDG1t3hg+oTIPCb8Pb4ccm8yvfPUF+E7btZ9/v9F1/qiNx3R3xAtZH8Pap8IQPQmIPpUW6IPbRf9zQLyev1g95PsryhUw4zEjDKx9+cEEMtrDmYHdOuwQIg3NA8pw5jm8rFsr7IiKyZ/gcP8NK2c3y95eGxf+wcdDcev/+vTw7k45zbq+st3v/773/8f7kWRjg==";
\ No newline at end of file
diff --git a/docs/jetstream/classes/JetStreamApiError.html b/docs/jetstream/classes/JetStreamApiError.html
index 0f2af294..b751d22b 100644
--- a/docs/jetstream/classes/JetStreamApiError.html
+++ b/docs/jetstream/classes/JetStreamApiError.html
@@ -1,15 +1,36 @@
-JetStreamApiError | @nats-io/jetstream
                                                                            @nats-io/jetstream
                                                                              Preparing search index...
                                                                              Class JetStreamApiError
                                                                              Hierarchy
                                                                              • Error
                                                                                • JetStreamApiError
                                                                              Index
                                                                              Constructors
                                                                              constructor
+JetStreamApiError | @nats-io/jetstream
                                                                              @nats-io/jetstream
                                                                                Preparing search index...
                                                                                Class JetStreamApiError
                                                                                Hierarchy
                                                                                • Error
                                                                                  • JetStreamApiError
                                                                                Index
                                                                                Constructors
                                                                                constructor
 
                                                                                Properties
                                                                                cause?
 message
 name
 stack?
-prepareStackTrace?
 stackTraceLimit
 
                                                                                Accessors
                                                                                code
 status
 
                                                                                Methods
                                                                                apiError
 captureStackTrace
-
                                                                                Constructors
                                                                                Properties
                                                                                cause?: unknown
                                                                                message: string
                                                                                name: string
                                                                                stack?: string
                                                                                prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any
                                                                                Optional override for formatting stack traces
                                                                                
-
                                                                                https://v8.dev/docs/stack-trace-api#customizing-stack-traces
                                                                                
-
                                                                                stackTraceLimit: number
                                                                                Accessors
                                                                                • get code(): number
                                                                                  Returns number
                                                                                • get status(): number
                                                                                  Returns number
                                                                                Methods
                                                                                • Returns ApiError
                                                                                • Create .stack property on a target object
                                                                                  
-
                                                                                  Parameters
                                                                                  • targetObject: object
                                                                                  • OptionalconstructorOpt: Function
                                                                                  Returns void
                                                                                Settings
                                                                                Member Visibility
                                                                                On This Page
                                                                                Constructors
                                                                                Properties
                                                                                Accessors
                                                                                Methods
                                                                                
+prepareStackTrace
+
                                                                                Constructors
                                                                                Properties
                                                                                cause?: unknown
                                                                                message: string
                                                                                name: string
                                                                                stack?: string
                                                                                stackTraceLimit: number
                                                                                The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                
+
                                                                                The default value is 10 but may be set to any valid JavaScript number. Changes
+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.
                                                                                
+
                                                                                Accessors
                                                                                • get code(): number
                                                                                  Returns number
                                                                                • get status(): number
                                                                                  Returns number
                                                                                Methods
                                                                                • Returns ApiError
                                                                                • 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`
+
                                                                                  
+
+
                                                                                  The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                  
+
                                                                                  The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                  
+
                                                                                  The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                  
+
                                                                                  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
                                                                                Accessors
                                                                                Methods
                                                                                
diff --git a/docs/jetstream/classes/JetStreamError.html b/docs/jetstream/classes/JetStreamError.html
index f41de76c..a8709a4d 100644
--- a/docs/jetstream/classes/JetStreamError.html
+++ b/docs/jetstream/classes/JetStreamError.html
@@ -1,12 +1,33 @@
-JetStreamError | @nats-io/jetstream
                                                                                @nats-io/jetstream
                                                                                  Preparing search index...
                                                                                  Class JetStreamError
                                                                                  Hierarchy
                                                                                  • Error
                                                                                    • JetStreamError
                                                                                  Index
                                                                                  Constructors
                                                                                  constructor
+JetStreamError | @nats-io/jetstream
                                                                                  @nats-io/jetstream
                                                                                    Preparing search index...
                                                                                    Class JetStreamError
                                                                                    Hierarchy
                                                                                    • Error
                                                                                      • JetStreamError
                                                                                    Index
                                                                                    Constructors
                                                                                    constructor
 
                                                                                    Properties
                                                                                    cause?
 message
 name
 stack?
-prepareStackTrace?
 stackTraceLimit
 
                                                                                    Methods
                                                                                    captureStackTrace
-
                                                                                    Constructors
                                                                                    • Parameters
                                                                                      • message: string
                                                                                      • Optionalopts: ErrorOptions
                                                                                      Returns JetStreamError
                                                                                    Properties
                                                                                    cause?: unknown
                                                                                    message: string
                                                                                    name: string
                                                                                    stack?: string
                                                                                    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any
                                                                                    Optional override for formatting stack traces
                                                                                    
-
                                                                                    https://v8.dev/docs/stack-trace-api#customizing-stack-traces
                                                                                    
-
                                                                                    stackTraceLimit: number
                                                                                    Methods
                                                                                    • Create .stack property on a target object
                                                                                      
-
                                                                                      Parameters
                                                                                      • targetObject: object
                                                                                      • OptionalconstructorOpt: Function
                                                                                      Returns void
                                                                                    Settings
                                                                                    Member Visibility
                                                                                    On This Page
                                                                                    Constructors
                                                                                    Properties
                                                                                    Methods
                                                                                    
+prepareStackTrace
+
                                                                                    Constructors
                                                                                    • Parameters
                                                                                      • message: string
                                                                                      • Optionalopts: ErrorOptions
                                                                                      Returns JetStreamError
                                                                                    Properties
                                                                                    cause?: unknown
                                                                                    message: string
                                                                                    name: string
                                                                                    stack?: string
                                                                                    stackTraceLimit: number
                                                                                    The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                    
+
                                                                                    The default value is 10 but may be set to any valid JavaScript number. Changes
+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
+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`
+
                                                                                      
+
+
                                                                                      The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                      
+
                                                                                      The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                      
+
                                                                                      The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                      
+
                                                                                      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
                                                                                    
diff --git a/docs/jetstream/functions/isPullConsumer.html b/docs/jetstream/functions/isPullConsumer.html
index 50364c9a..e91f9fb5 100644
--- a/docs/jetstream/functions/isPullConsumer.html
+++ b/docs/jetstream/functions/isPullConsumer.html
@@ -1 +1 @@
-isPullConsumer | @nats-io/jetstream
                                                                                    @nats-io/jetstream
                                                                                      Preparing search index...
                                                                                      Function isPullConsumer
                                                                                      Settings
                                                                                      Member Visibility
                                                                                      
+isPullConsumer | @nats-io/jetstream
                                                                                      @nats-io/jetstream
                                                                                        Preparing search index...
                                                                                        Function isPullConsumer
                                                                                        Settings
                                                                                        Member Visibility
                                                                                        
diff --git a/docs/jetstream/functions/isPushConsumer.html b/docs/jetstream/functions/isPushConsumer.html
index 32591e07..a3113d3f 100644
--- a/docs/jetstream/functions/isPushConsumer.html
+++ b/docs/jetstream/functions/isPushConsumer.html
@@ -1 +1 @@
-isPushConsumer | @nats-io/jetstream
                                                                                        @nats-io/jetstream
                                                                                          Preparing search index...
                                                                                          Function isPushConsumer
                                                                                          Settings
                                                                                          Member Visibility
                                                                                          
+isPushConsumer | @nats-io/jetstream
                                                                                          @nats-io/jetstream
                                                                                            Preparing search index...
                                                                                            Function isPushConsumer
                                                                                            Settings
                                                                                            Member Visibility
                                                                                            
diff --git a/docs/jetstream/functions/jetstream.html b/docs/jetstream/functions/jetstream.html
index beb3c328..49d1edf9 100644
--- a/docs/jetstream/functions/jetstream.html
+++ b/docs/jetstream/functions/jetstream.html
@@ -1,2 +1,2 @@
 jetstream | @nats-io/jetstream
                                                                                            @nats-io/jetstream
                                                                                              Preparing search index...
                                                                                              Function jetstream
                                                                                              Settings
                                                                                              Member Visibility
                                                                                              
+
                                                                                              Parameters
                                                                                              Returns JetStreamClient
                                                                                              Settings
                                                                                              Member Visibility
                                                                                              
diff --git a/docs/jetstream/functions/jetstreamManager.html b/docs/jetstream/functions/jetstreamManager.html
index 97090bb5..cc0cf28c 100644
--- a/docs/jetstream/functions/jetstreamManager.html
+++ b/docs/jetstream/functions/jetstreamManager.html
@@ -1,2 +1,2 @@
 jetstreamManager | @nats-io/jetstream
                                                                                              @nats-io/jetstream
                                                                                                Preparing search index...
                                                                                                Function jetstreamManager
                                                                                                Settings
                                                                                                Member Visibility
                                                                                                
+
                                                                                                Parameters
                                                                                                Returns Promise<JetStreamManager>
                                                                                                Settings
                                                                                                Member Visibility
                                                                                                
diff --git a/docs/jetstream/index.html b/docs/jetstream/index.html
index ce33860a..526666c8 100644
--- a/docs/jetstream/index.html
+++ b/docs/jetstream/index.html
@@ -1,5 +1,5 @@
 @nats-io/jetstream
                                                                                                @nats-io/jetstream
                                                                                                  Preparing search index...
                                                                                                  @nats-io/jetstream
                                                                                                  License
-jetstream
+jetstream
 JSDoc
                                                                                                  
 
                                                                                                  JSR
 JSR
                                                                                                  
diff --git a/docs/jetstream/media/README-1.md b/docs/jetstream/media/README-1.md
index 9d1f1a14..84759314 100644
--- a/docs/jetstream/media/README-1.md
+++ b/docs/jetstream/media/README-1.md
@@ -1,5 +1,5 @@
 [![License](https://img.shields.io/badge/Licence-Apache%202.0-blue.svg)](./LICENSE)
-![jetstream](https://github.com/nats-io/nats.js/actions/workflows/obj.yml/badge.svg)
+![obj](https://github.com/nats-io/nats.js/actions/workflows/test.yml/badge.svg)
 [![JSDoc](https://img.shields.io/badge/JSDoc-reference-blue)](https://nats-io.github.io/nats.js/obj/index.html)
 
 [![JSR](https://jsr.io/badges/@nats-io/obj)](https://jsr.io/@nats-io/obj)
diff --git a/docs/jetstream/media/README.md b/docs/jetstream/media/README.md
index 7a762303..ce359920 100644
--- a/docs/jetstream/media/README.md
+++ b/docs/jetstream/media/README.md
@@ -1,5 +1,5 @@
 [![License](https://img.shields.io/badge/Licence-Apache%202.0-blue.svg)](./LICENSE)
-![jetstream](https://github.com/nats-io/nats.js/actions/workflows/kv.yml/badge.svg)
+![kv](https://github.com/nats-io/nats.js/actions/workflows/test.yml/badge.svg)
 [![JSDoc](https://img.shields.io/badge/JSDoc-reference-blue)](https://nats-io.github.io/nats.js/kv/index.html)
 
 [![JSR](https://jsr.io/badges/@nats-io/kv)](https://jsr.io/@nats-io/kv)
@@ -128,7 +128,7 @@ const watch = await kv.watch();
 })().then();
 
 // update the entry
-await kv.put("hello.world", sc.encode("world"));
+await kv.put("hello.world", "world");
 // retrieve the KvEntry storing the value
 // returns null if the value is not found
 const e = await kv.get("hello.world");
diff --git a/docs/jetstream/modules.html b/docs/jetstream/modules.html
index ad78f81a..74daef09 100644
--- a/docs/jetstream/modules.html
+++ b/docs/jetstream/modules.html
@@ -1 +1 @@
-@nats-io/jetstream
                                                                                                  @nats-io/jetstream
                                                                                                    Preparing search index...
                                                                                                      @nats-io/jetstream
                                                                                                      Classes
                                                                                                      JetStreamApiError
                                                                                                      JetStreamError
                                                                                                      Type Aliases
                                                                                                      AbortOnMissingResource
                                                                                                      AccountLimits
                                                                                                      AckPolicy
                                                                                                      Advisory
                                                                                                      AdvisoryKind
                                                                                                      ApiError
                                                                                                      ApiPaged
                                                                                                      ApiPagedRequest
                                                                                                      BatchCallback
                                                                                                      Bind
                                                                                                      BoundPushConsumerOptions
                                                                                                      Close
                                                                                                      Closed
                                                                                                      ClusterInfo
                                                                                                      CompletionResult
                                                                                                      ConsumeBytes
                                                                                                      ConsumeCallback
                                                                                                      ConsumeMessages
                                                                                                      ConsumeOptions
                                                                                                      Consumer
                                                                                                      ConsumerAPI
                                                                                                      ConsumerCallbackFn
                                                                                                      ConsumerConfig
                                                                                                      ConsumerCreateOptions
                                                                                                      ConsumerDeleted
                                                                                                      ConsumerInfo
                                                                                                      ConsumerKind
                                                                                                      ConsumerMessages
                                                                                                      ConsumerNotFound
                                                                                                      ConsumerNotification
                                                                                                      ConsumerPinned
                                                                                                      Consumers
                                                                                                      ConsumerUnpinned
                                                                                                      ConsumerUpdateConfig
                                                                                                      Debug
                                                                                                      DeleteableConsumer
                                                                                                      DeliverPolicy
                                                                                                      DeliveryInfo
                                                                                                      Destroyable
                                                                                                      DirectBatchLimits
                                                                                                      DirectBatchOptions
                                                                                                      DirectBatchStartSeq
                                                                                                      DirectBatchStartTime
                                                                                                      DirectLastFor
                                                                                                      DirectMsgHeaders
                                                                                                      DirectMsgRequest
                                                                                                      DirectStreamAPI
                                                                                                      Discard
                                                                                                      DiscardPolicy
                                                                                                      ExceededLimits
                                                                                                      Expires
                                                                                                      ExportedConsumer
                                                                                                      ExternalStream
                                                                                                      FetchBytes
                                                                                                      FetchMessages
                                                                                                      FetchOptions
                                                                                                      FlowControl
                                                                                                      Heartbeat
                                                                                                      HeartbeatsMissed
                                                                                                      IdleHeartbeat
                                                                                                      InfoableConsumer
                                                                                                      JetStreamAccountStats
                                                                                                      JetStreamApiCodes
                                                                                                      JetStreamApiStats
                                                                                                      JetStreamClient
                                                                                                      JetStreamManager
                                                                                                      JetStreamManagerOptions
                                                                                                      JetStreamOptions
                                                                                                      JetStreamPublishOptions
                                                                                                      JetStreamUsage
                                                                                                      JetStreamUsageAccountLimits
                                                                                                      JsHeaders
                                                                                                      JsMsg
                                                                                                      LastForMsgRequest
                                                                                                      Lister
                                                                                                      LostStreamData
                                                                                                      MaxBytes
                                                                                                      MaxMessages
                                                                                                      MsgDeleteRequest
                                                                                                      MsgRequest
                                                                                                      Next
                                                                                                      NextMsgRequest
                                                                                                      NextOptions
                                                                                                      NoResponders
                                                                                                      OrderedConsumerOptions
                                                                                                      OrderedConsumerRecreated
                                                                                                      OrderedPushConsumerOptions
                                                                                                      OverflowMinAckPending
                                                                                                      OverflowMinPending
                                                                                                      OverflowMinPendingAndMinAck
                                                                                                      OverflowOptions
                                                                                                      PeerInfo
                                                                                                      Placement
                                                                                                      PriorityGroups
                                                                                                      PriorityPolicy
                                                                                                      PubAck
                                                                                                      PullOptions
                                                                                                      PurgeBySeq
                                                                                                      PurgeBySubject
                                                                                                      PurgeOpts
                                                                                                      PurgeResponse
                                                                                                      PurgeTrimOpts
                                                                                                      PushConsumer
                                                                                                      PushConsumerOptions
                                                                                                      ReplayPolicy
                                                                                                      Republish
                                                                                                      RepublishHeaders
                                                                                                      Reset
                                                                                                      RetentionPolicy
                                                                                                      SeqMsgRequest
                                                                                                      SequenceInfo
                                                                                                      StartTimeMsgRequest
                                                                                                      StorageType
                                                                                                      StoreCompression
                                                                                                      StoredMsg
                                                                                                      Stream
                                                                                                      StreamAlternate
                                                                                                      StreamAPI
                                                                                                      StreamConfig
                                                                                                      StreamConsumerLimits
                                                                                                      StreamInfo
                                                                                                      StreamInfoRequestOptions
                                                                                                      StreamNames
                                                                                                      StreamNotFound
                                                                                                      Streams
                                                                                                      StreamSource
                                                                                                      StreamSourceInfo
                                                                                                      StreamState
                                                                                                      StreamUpdateConfig
                                                                                                      SubjectTransformConfig
                                                                                                      Success
                                                                                                      ThresholdBytes
                                                                                                      ThresholdMessages
                                                                                                      Variables
                                                                                                      AckPolicy
                                                                                                      AdvisoryKind
                                                                                                      DeliverPolicy
                                                                                                      DirectMsgHeaders
                                                                                                      DiscardPolicy
                                                                                                      JetStreamApiCodes
                                                                                                      JsHeaders
                                                                                                      PriorityPolicy
                                                                                                      ReplayPolicy
                                                                                                      RepublishHeaders
                                                                                                      RetentionPolicy
                                                                                                      StorageType
                                                                                                      StoreCompression
                                                                                                      Functions
                                                                                                      isPullConsumer
                                                                                                      isPushConsumer
                                                                                                      jetstream
                                                                                                      jetstreamManager
                                                                                                      Settings
                                                                                                      Member Visibility
                                                                                                      On This Page
                                                                                                      Classes
                                                                                                      Type Aliases
                                                                                                      AbortOnMissingResourceAccountLimitsAckPolicyAdvisoryAdvisoryKindApiErrorApiPagedApiPagedRequestBatchCallbackBindBoundPushConsumerOptionsCloseClosedClusterInfoCompletionResultConsumeBytesConsumeCallbackConsumeMessagesConsumeOptionsConsumerConsumerAPIConsumerCallbackFnConsumerConfigConsumerCreateOptionsConsumerDeletedConsumerInfoConsumerKindConsumerMessagesConsumerNotFoundConsumerNotificationConsumerPinnedConsumersConsumerUnpinnedConsumerUpdateConfigDebugDeleteableConsumerDeliverPolicyDeliveryInfoDestroyableDirectBatchLimitsDirectBatchOptionsDirectBatchStartSeqDirectBatchStartTimeDirectLastForDirectMsgHeadersDirectMsgRequestDirectStreamAPIDiscardDiscardPolicyExceededLimitsExpiresExportedConsumerExternalStreamFetchBytesFetchMessagesFetchOptionsFlowControlHeartbeatHeartbeatsMissedIdleHeartbeatInfoableConsumerJetStreamAccountStatsJetStreamApiCodesJetStreamApiStatsJetStreamClientJetStreamManagerJetStreamManagerOptionsJetStreamOptionsJetStreamPublishOptionsJetStreamUsageJetStreamUsageAccountLimitsJsHeadersJsMsgLastForMsgRequestListerLostStreamDataMaxBytesMaxMessagesMsgDeleteRequestMsgRequestNextNextMsgRequestNextOptionsNoRespondersOrderedConsumerOptionsOrderedConsumerRecreatedOrderedPushConsumerOptionsOverflowMinAckPendingOverflowMinPendingOverflowMinPendingAndMinAckOverflowOptionsPeerInfoPlacementPriorityGroupsPriorityPolicyPubAckPullOptionsPurgeBySeqPurgeBySubjectPurgeOptsPurgeResponsePurgeTrimOptsPushConsumerPushConsumerOptionsReplayPolicyRepublishRepublishHeadersResetRetentionPolicySeqMsgRequestSequenceInfoStartTimeMsgRequestStorageTypeStoreCompressionStoredMsgStreamStreamAlternateStreamAPIStreamConfigStreamConsumerLimitsStreamInfoStreamInfoRequestOptionsStreamNamesStreamNotFoundStreamsStreamSourceStreamSourceInfoStreamStateStreamUpdateConfigSubjectTransformConfigSuccessThresholdBytesThresholdMessages
                                                                                                      Variables
                                                                                                      Functions
                                                                                                      
+@nats-io/jetstream
                                                                                                      @nats-io/jetstream
                                                                                                        Preparing search index...
                                                                                                          @nats-io/jetstream
                                                                                                          Classes
                                                                                                          JetStreamApiError
                                                                                                          JetStreamError
                                                                                                          Type Aliases
                                                                                                          AbortOnMissingResource
                                                                                                          AccountLimits
                                                                                                          AckPolicy
                                                                                                          Advisory
                                                                                                          AdvisoryKind
                                                                                                          ApiError
                                                                                                          ApiPaged
                                                                                                          ApiPagedRequest
                                                                                                          Batch
                                                                                                          BatchAck
                                                                                                          BatchCallback
                                                                                                          BatchMessageOptions
                                                                                                          BatchMessageOptionsWithReply
                                                                                                          Bind
                                                                                                          BoundPushConsumerOptions
                                                                                                          Close
                                                                                                          Closed
                                                                                                          ClusterInfo
                                                                                                          CompletionResult
                                                                                                          ConsumeBytes
                                                                                                          ConsumeCallback
                                                                                                          ConsumeMessages
                                                                                                          ConsumeOptions
                                                                                                          Consumer
                                                                                                          ConsumerAPI
                                                                                                          ConsumerCallbackFn
                                                                                                          ConsumerConfig
                                                                                                          ConsumerCreateOptions
                                                                                                          ConsumerDeleted
                                                                                                          ConsumerInfo
                                                                                                          ConsumerKind
                                                                                                          ConsumerMessages
                                                                                                          ConsumerNotFound
                                                                                                          ConsumerNotification
                                                                                                          ConsumerPinned
                                                                                                          Consumers
                                                                                                          ConsumerUnpinned
                                                                                                          ConsumerUpdateConfig
                                                                                                          Debug
                                                                                                          DeleteableConsumer
                                                                                                          DeliverPolicy
                                                                                                          DeliveryInfo
                                                                                                          Destroyable
                                                                                                          DirectBatchLimits
                                                                                                          DirectBatchOptions
                                                                                                          DirectBatchStartSeq
                                                                                                          DirectBatchStartTime
                                                                                                          DirectLastFor
                                                                                                          DirectMsgHeaders
                                                                                                          DirectMsgRequest
                                                                                                          DirectStreamAPI
                                                                                                          Discard
                                                                                                          DiscardPolicy
                                                                                                          ExceededLimits
                                                                                                          Expires
                                                                                                          ExportedConsumer
                                                                                                          ExternalStream
                                                                                                          FetchBytes
                                                                                                          FetchMessages
                                                                                                          FetchOptions
                                                                                                          FlowControl
                                                                                                          Heartbeat
                                                                                                          HeartbeatsMissed
                                                                                                          IdleHeartbeat
                                                                                                          InfoableConsumer
                                                                                                          JetStreamAccountStats
                                                                                                          JetStreamApiCodes
                                                                                                          JetStreamApiStats
                                                                                                          JetStreamClient
                                                                                                          JetStreamManager
                                                                                                          JetStreamManagerOptions
                                                                                                          JetStreamOptions
                                                                                                          JetStreamPublishOptions
                                                                                                          JetStreamUsage
                                                                                                          JetStreamUsageAccountLimits
                                                                                                          JsHeaders
                                                                                                          JsMsg
                                                                                                          LastForMsgRequest
                                                                                                          Lister
                                                                                                          LostStreamData
                                                                                                          MaxBytes
                                                                                                          MaxMessages
                                                                                                          MsgDeleteRequest
                                                                                                          MsgRequest
                                                                                                          Next
                                                                                                          NextMsgRequest
                                                                                                          NextOptions
                                                                                                          NoResponders
                                                                                                          OrderedConsumerOptions
                                                                                                          OrderedConsumerRecreated
                                                                                                          OrderedPushConsumerOptions
                                                                                                          OverflowMinAckPending
                                                                                                          OverflowMinPending
                                                                                                          OverflowMinPendingAndMinAck
                                                                                                          OverflowOptions
                                                                                                          PeerInfo
                                                                                                          PersistMode
                                                                                                          Placement
                                                                                                          PrioritizedOptions
                                                                                                          PriorityGroups
                                                                                                          PriorityPolicy
                                                                                                          PubAck
                                                                                                          PubHeaders
                                                                                                          PullOptions
                                                                                                          PurgeBySeq
                                                                                                          PurgeBySubject
                                                                                                          PurgeOpts
                                                                                                          PurgeResponse
                                                                                                          PurgeTrimOpts
                                                                                                          PushConsumer
                                                                                                          PushConsumerOptions
                                                                                                          ReplayPolicy
                                                                                                          Republish
                                                                                                          RepublishHeaders
                                                                                                          Reset
                                                                                                          RetentionPolicy
                                                                                                          ScheduleOptions
                                                                                                          SeqMsgRequest
                                                                                                          SequenceInfo
                                                                                                          StartTimeMsgRequest
                                                                                                          StorageType
                                                                                                          StoreCompression
                                                                                                          StoredMsg
                                                                                                          Stream
                                                                                                          StreamAlternate
                                                                                                          StreamAPI
                                                                                                          StreamConfig
                                                                                                          StreamConsumerLimits
                                                                                                          StreamExpectations
                                                                                                          StreamInfo
                                                                                                          StreamInfoRequestOptions
                                                                                                          StreamNames
                                                                                                          StreamNotFound
                                                                                                          Streams
                                                                                                          StreamSource
                                                                                                          StreamSourceInfo
                                                                                                          StreamState
                                                                                                          StreamUpdateConfig
                                                                                                          SubjectTransformConfig
                                                                                                          Success
                                                                                                          ThresholdBytes
                                                                                                          ThresholdMessages
                                                                                                          Variables
                                                                                                          AckPolicy
                                                                                                          AdvisoryKind
                                                                                                          DeliverPolicy
                                                                                                          DirectMsgHeaders
                                                                                                          DiscardPolicy
                                                                                                          JetStreamApiCodes
                                                                                                          JsHeaders
                                                                                                          PersistMode
                                                                                                          PriorityPolicy
                                                                                                          PubHeaders
                                                                                                          ReplayPolicy
                                                                                                          RepublishHeaders
                                                                                                          RetentionPolicy
                                                                                                          StorageType
                                                                                                          StoreCompression
                                                                                                          Functions
                                                                                                          isPullConsumer
                                                                                                          isPushConsumer
                                                                                                          jetstream
                                                                                                          jetstreamManager
                                                                                                          Settings
                                                                                                          Member Visibility
                                                                                                          On This Page
                                                                                                          Classes
                                                                                                          Type Aliases
                                                                                                          AbortOnMissingResourceAccountLimitsAckPolicyAdvisoryAdvisoryKindApiErrorApiPagedApiPagedRequestBatchBatchAckBatchCallbackBatchMessageOptionsBatchMessageOptionsWithReplyBindBoundPushConsumerOptionsCloseClosedClusterInfoCompletionResultConsumeBytesConsumeCallbackConsumeMessagesConsumeOptionsConsumerConsumerAPIConsumerCallbackFnConsumerConfigConsumerCreateOptionsConsumerDeletedConsumerInfoConsumerKindConsumerMessagesConsumerNotFoundConsumerNotificationConsumerPinnedConsumersConsumerUnpinnedConsumerUpdateConfigDebugDeleteableConsumerDeliverPolicyDeliveryInfoDestroyableDirectBatchLimitsDirectBatchOptionsDirectBatchStartSeqDirectBatchStartTimeDirectLastForDirectMsgHeadersDirectMsgRequestDirectStreamAPIDiscardDiscardPolicyExceededLimitsExpiresExportedConsumerExternalStreamFetchBytesFetchMessagesFetchOptionsFlowControlHeartbeatHeartbeatsMissedIdleHeartbeatInfoableConsumerJetStreamAccountStatsJetStreamApiCodesJetStreamApiStatsJetStreamClientJetStreamManagerJetStreamManagerOptionsJetStreamOptionsJetStreamPublishOptionsJetStreamUsageJetStreamUsageAccountLimitsJsHeadersJsMsgLastForMsgRequestListerLostStreamDataMaxBytesMaxMessagesMsgDeleteRequestMsgRequestNextNextMsgRequestNextOptionsNoRespondersOrderedConsumerOptionsOrderedConsumerRecreatedOrderedPushConsumerOptionsOverflowMinAckPendingOverflowMinPendingOverflowMinPendingAndMinAckOverflowOptionsPeerInfoPersistModePlacementPrioritizedOptionsPriorityGroupsPriorityPolicyPubAckPubHeadersPullOptionsPurgeBySeqPurgeBySubjectPurgeOptsPurgeResponsePurgeTrimOptsPushConsumerPushConsumerOptionsReplayPolicyRepublishRepublishHeadersResetRetentionPolicyScheduleOptionsSeqMsgRequestSequenceInfoStartTimeMsgRequestStorageTypeStoreCompressionStoredMsgStreamStreamAlternateStreamAPIStreamConfigStreamConsumerLimitsStreamExpectationsStreamInfoStreamInfoRequestOptionsStreamNamesStreamNotFoundStreamsStreamSourceStreamSourceInfoStreamStateStreamUpdateConfigSubjectTransformConfigSuccessThresholdBytesThresholdMessages
                                                                                                          Variables
                                                                                                          Functions
                                                                                                          
diff --git a/docs/jetstream/types/AbortOnMissingResource.html b/docs/jetstream/types/AbortOnMissingResource.html
index 8fbbb64f..49c915fb 100644
--- a/docs/jetstream/types/AbortOnMissingResource.html
+++ b/docs/jetstream/types/AbortOnMissingResource.html
@@ -1,4 +1,4 @@
-AbortOnMissingResource | @nats-io/jetstream
                                                                                                          @nats-io/jetstream
                                                                                                            Preparing search index...
                                                                                                            Type Alias AbortOnMissingResource
                                                                                                            type AbortOnMissingResource = {
                                                                                                                abort_on_missing_resource?: boolean;
                                                                                                            }
                                                                                                            Index
                                                                                                            Properties
                                                                                                            abort_on_missing_resource?
+AbortOnMissingResource | @nats-io/jetstream
                                                                                                            @nats-io/jetstream
                                                                                                              Preparing search index...
                                                                                                              Type Alias AbortOnMissingResource
                                                                                                              type AbortOnMissingResource = {
                                                                                                                  abort_on_missing_resource?: boolean;
                                                                                                              }
                                                                                                              Index
                                                                                                              Properties
                                                                                                              abort_on_missing_resource?
 
                                                                                                              Properties
                                                                                                              abort_on_missing_resource?: boolean
                                                                                                              If true, consume will abort if the stream or consumer is not found. Default is to recover
 once the stream/consumer is restored. This option is exclusive of bind.
                                                                                                              
-
                                                                                                              Settings
                                                                                                              Member Visibility
                                                                                                              On This Page
                                                                                                              Properties
                                                                                                              
+
                                                                                                              Settings
                                                                                                              Member Visibility
                                                                                                              On This Page
                                                                                                              Properties
                                                                                                              
diff --git a/docs/jetstream/types/AccountLimits.html b/docs/jetstream/types/AccountLimits.html
index 9934d9e8..efcb8cd9 100644
--- a/docs/jetstream/types/AccountLimits.html
+++ b/docs/jetstream/types/AccountLimits.html
@@ -1,4 +1,4 @@
-AccountLimits | @nats-io/jetstream
                                                                                                              @nats-io/jetstream
                                                                                                                Preparing search index...
                                                                                                                Type Alias AccountLimits
                                                                                                                type AccountLimits = {
                                                                                                                    max_ack_pending: number;
                                                                                                                    max_bytes_required: number;
                                                                                                                    max_consumers: number;
                                                                                                                    max_memory: number;
                                                                                                                    max_storage: number;
                                                                                                                    max_streams: number;
                                                                                                                    memory_max_stream_bytes: number;
                                                                                                                    storage_max_stream_bytes: number;
                                                                                                                }
                                                                                                                Index
                                                                                                                Properties
                                                                                                                max_ack_pending
+AccountLimits | @nats-io/jetstream
                                                                                                                @nats-io/jetstream
                                                                                                                  Preparing search index...
                                                                                                                  Type Alias AccountLimits
                                                                                                                  type AccountLimits = {
                                                                                                                      max_ack_pending: number;
                                                                                                                      max_bytes_required: number;
                                                                                                                      max_consumers: number;
                                                                                                                      max_memory: number;
                                                                                                                      max_storage: number;
                                                                                                                      max_streams: number;
                                                                                                                      memory_max_stream_bytes: number;
                                                                                                                      storage_max_stream_bytes: number;
                                                                                                                  }
                                                                                                                  Index
                                                                                                                  Properties
                                                                                                                  max_ack_pending
 max_bytes_required
 max_consumers
 max_memory
@@ -7,11 +7,11 @@
 memory_max_stream_bytes
 storage_max_stream_bytes
 
                                                                                                                  Properties
                                                                                                                  max_ack_pending: number
                                                                                                                  The maximum number of outstanding ACKs any consumer may configure
                                                                                                                  
-
                                                                                                                  max_bytes_required: number
                                                                                                                  Indicates if Streams created in this account requires the max_bytes property set
                                                                                                                  
-
                                                                                                                  max_consumers: number
                                                                                                                  The maximum number of Consumer an account can create
                                                                                                                  
-
                                                                                                                  max_memory: number
                                                                                                                  The maximum amount of Memory storage Stream Messages may consume
                                                                                                                  
-
                                                                                                                  max_storage: number
                                                                                                                  The maximum amount of File storage Stream Messages may consume
                                                                                                                  
-
                                                                                                                  max_streams: number
                                                                                                                  The maximum number of Streams an account can create
                                                                                                                  
-
                                                                                                                  memory_max_stream_bytes: number
                                                                                                                  The maximum size any single memory stream may be
                                                                                                                  
-
                                                                                                                  storage_max_stream_bytes: number
                                                                                                                  The maximum size any single storage based stream may be
                                                                                                                  
-
                                                                                                                  Settings
                                                                                                                  Member Visibility
                                                                                                                  On This Page
                                                                                                                  Properties
                                                                                                                  
+
                                                                                                                  max_bytes_required: number
                                                                                                                  Indicates if Streams created in this account requires the max_bytes property set
                                                                                                                  
+
                                                                                                                  max_consumers: number
                                                                                                                  The maximum number of Consumer an account can create
                                                                                                                  
+
                                                                                                                  max_memory: number
                                                                                                                  The maximum amount of Memory storage Stream Messages may consume
                                                                                                                  
+
                                                                                                                  max_storage: number
                                                                                                                  The maximum amount of File storage Stream Messages may consume
                                                                                                                  
+
                                                                                                                  max_streams: number
                                                                                                                  The maximum number of Streams an account can create
                                                                                                                  
+
                                                                                                                  memory_max_stream_bytes: number
                                                                                                                  The maximum size any single memory stream may be
                                                                                                                  
+
                                                                                                                  storage_max_stream_bytes: number
                                                                                                                  The maximum size any single storage based stream may be
                                                                                                                  
+
                                                                                                                  Settings
                                                                                                                  Member Visibility
                                                                                                                  On This Page
                                                                                                                  Properties
                                                                                                                  
diff --git a/docs/jetstream/types/AckPolicy.html b/docs/jetstream/types/AckPolicy.html
index 0e88c990..3c1dfeb2 100644
--- a/docs/jetstream/types/AckPolicy.html
+++ b/docs/jetstream/types/AckPolicy.html
@@ -1 +1 @@
-AckPolicy | @nats-io/jetstream
                                                                                                                  @nats-io/jetstream
                                                                                                                    Preparing search index...
                                                                                                                    Type Alias AckPolicy
                                                                                                                    AckPolicy: typeof AckPolicy[keyof typeof AckPolicy]
                                                                                                                    Settings
                                                                                                                    Member Visibility
                                                                                                                    
+AckPolicy | @nats-io/jetstream
                                                                                                                    @nats-io/jetstream
                                                                                                                      Preparing search index...
                                                                                                                      Type Alias AckPolicy
                                                                                                                      AckPolicy: typeof AckPolicy[keyof typeof AckPolicy]
                                                                                                                      Settings
                                                                                                                      Member Visibility
                                                                                                                      
diff --git a/docs/jetstream/types/Advisory.html b/docs/jetstream/types/Advisory.html
index f2e121d2..55fa7bba 100644
--- a/docs/jetstream/types/Advisory.html
+++ b/docs/jetstream/types/Advisory.html
@@ -1,6 +1,6 @@
 Advisory | @nats-io/jetstream
                                                                                                                      @nats-io/jetstream
                                                                                                                        Preparing search index...
                                                                                                                        Type Alias Advisory
                                                                                                                        An advisory is an interesting event in the JetStream server
                                                                                                                        
-
                                                                                                                        type Advisory = {
                                                                                                                            data: unknown;
                                                                                                                            kind: AdvisoryKind;
                                                                                                                        }
                                                                                                                        Index
                                                                                                                        Properties
                                                                                                                        data
+
                                                                                                                        type Advisory = {
                                                                                                                            data: unknown;
                                                                                                                            kind: AdvisoryKind;
                                                                                                                        }
                                                                                                                        Index
                                                                                                                        Properties
                                                                                                                        data
 kind
 
                                                                                                                        Properties
                                                                                                                        data: unknown
                                                                                                                        Payload associated with the advisory
                                                                                                                        
-
                                                                                                                        kind: AdvisoryKind
                                                                                                                        The type of the advisory
                                                                                                                        
-
                                                                                                                        Settings
                                                                                                                        Member Visibility
                                                                                                                        On This Page
                                                                                                                        Properties
                                                                                                                        
+
                                                                                                                        kind: AdvisoryKind
                                                                                                                        The type of the advisory
                                                                                                                        
+
                                                                                                                        Settings
                                                                                                                        Member Visibility
                                                                                                                        On This Page
                                                                                                                        Properties
                                                                                                                        
diff --git a/docs/jetstream/types/AdvisoryKind.html b/docs/jetstream/types/AdvisoryKind.html
index 4bb51357..47337d4a 100644
--- a/docs/jetstream/types/AdvisoryKind.html
+++ b/docs/jetstream/types/AdvisoryKind.html
@@ -1 +1 @@
-AdvisoryKind | @nats-io/jetstream
                                                                                                                        @nats-io/jetstream
                                                                                                                          Preparing search index...
                                                                                                                          Type Alias AdvisoryKind
                                                                                                                          AdvisoryKind: typeof AdvisoryKind[keyof typeof AdvisoryKind]
                                                                                                                          Settings
                                                                                                                          Member Visibility
                                                                                                                          
+AdvisoryKind | @nats-io/jetstream
                                                                                                                          @nats-io/jetstream
                                                                                                                            Preparing search index...
                                                                                                                            Type Alias AdvisoryKind
                                                                                                                            AdvisoryKind: typeof AdvisoryKind[keyof typeof AdvisoryKind]
                                                                                                                            Settings
                                                                                                                            Member Visibility
                                                                                                                            
diff --git a/docs/jetstream/types/Batch.html b/docs/jetstream/types/Batch.html
new file mode 100644
index 00000000..01368849
--- /dev/null
+++ b/docs/jetstream/types/Batch.html
@@ -0,0 +1,21 @@
+Batch | @nats-io/jetstream
                                                                                                                            @nats-io/jetstream
                                                                                                                              Preparing search index...
                                                                                                                              Type Alias Batch
                                                                                                                              A Batch represents a number of messages staged into a stream
+atomically. The batch has several limits imposed by the server,
+such as a batch may not contain more than 1000 messages (including
+the message starting and ending the batch. And no more than 50
+batches on a stream can be active. Batches that are inactive for more
+than 10 seconds, are abandoned by the server.
                                                                                                                              
+
                                                                                                                              For more information check the JetStream
+documentation.
                                                                                                                              
+
                                                                                                                              type Batch = {
                                                                                                                                  count: number;
                                                                                                                                  id: string;
                                                                                                                                  add(
                                                                                                                                      subj: string,
                                                                                                                                      payload?: Payload,
                                                                                                                                      opts?: Partial<BatchMessageOptions>,
                                                                                                                                  ): void;
                                                                                                                                  add(
                                                                                                                                      subj: string,
                                                                                                                                      payload?: Payload,
                                                                                                                                      opts?: Partial<BatchMessageOptionsWithReply>,
                                                                                                                                  ): Promise<void>;
                                                                                                                                  commit(
                                                                                                                                      subj: string,
                                                                                                                                      payload?: Payload,
                                                                                                                                      opts?: Partial<RequestOptions>,
                                                                                                                                  ): Promise<BatchAck>;
                                                                                                                              }
                                                                                                                              Index
                                                                                                                              Properties
                                                                                                                              count
+id
+
                                                                                                                              Methods
                                                                                                                              add
+commit
+
                                                                                                                              Properties
                                                                                                                              count: number
                                                                                                                              The current number of messages currently added to the batch
                                                                                                                              
+
                                                                                                                              id: string
                                                                                                                              The unique identifier for the batch, generated by the client when the
+batch is created.
                                                                                                                              
+
                                                                                                                              Methods
                                                                                                                              • Appends the next message to the batch.
                                                                                                                                
+
                                                                                                                                Parameters
                                                                                                                                Returns void
                                                                                                                              • Appends the next message to the batch, but will wait for the server to
+acknowledge the message.
                                                                                                                                
+
                                                                                                                                Parameters
                                                                                                                                Returns Promise<void>
                                                                                                                              • Commits the batch. This will publish the last message on the batch
+and will remove the batch from the client.
                                                                                                                                
+
                                                                                                                                Parameters
                                                                                                                                • subj: string
                                                                                                                                • Optionalpayload: Payload
                                                                                                                                • Optionalopts: Partial<RequestOptions>
                                                                                                                                Returns Promise<BatchAck>
                                                                                                                              Settings
                                                                                                                              Member Visibility
                                                                                                                              On This Page
                                                                                                                              Properties
                                                                                                                              Methods
                                                                                                                              
diff --git a/docs/jetstream/types/BatchAck.html b/docs/jetstream/types/BatchAck.html
new file mode 100644
index 00000000..2b529cb1
--- /dev/null
+++ b/docs/jetstream/types/BatchAck.html
@@ -0,0 +1 @@
+BatchAck | @nats-io/jetstream
                                                                                                                              @nats-io/jetstream
                                                                                                                                Preparing search index...
                                                                                                                                Type Alias BatchAck
                                                                                                                                BatchAck: { batch: string; count: number } & PubAck
                                                                                                                                Settings
                                                                                                                                Member Visibility
                                                                                                                                
diff --git a/docs/jetstream/types/BatchCallback.html b/docs/jetstream/types/BatchCallback.html
index d1b72775..ee2736c9 100644
--- a/docs/jetstream/types/BatchCallback.html
+++ b/docs/jetstream/types/BatchCallback.html
@@ -1 +1 @@
-BatchCallback | @nats-io/jetstream
                                                                                                                                @nats-io/jetstream
                                                                                                                                  Preparing search index...
                                                                                                                                  Type Alias BatchCallback<T>
                                                                                                                                  BatchCallback: (done: CompletionResult | null, d: T) => void
                                                                                                                                  Type Parameters
                                                                                                                                  • T
                                                                                                                                  Type declaration
                                                                                                                                  Settings
                                                                                                                                  Member Visibility
                                                                                                                                  
+BatchCallback | @nats-io/jetstream
                                                                                                                                  @nats-io/jetstream
                                                                                                                                    Preparing search index...
                                                                                                                                    Type Alias BatchCallback<T>
                                                                                                                                    BatchCallback: (done: CompletionResult | null, d: T) => void
                                                                                                                                    Type Parameters
                                                                                                                                    • T
                                                                                                                                    Type declaration
                                                                                                                                    Settings
                                                                                                                                    Member Visibility
                                                                                                                                    
diff --git a/docs/jetstream/types/BatchMessageOptions.html b/docs/jetstream/types/BatchMessageOptions.html
new file mode 100644
index 00000000..7ba15df1
--- /dev/null
+++ b/docs/jetstream/types/BatchMessageOptions.html
@@ -0,0 +1 @@
+BatchMessageOptions | @nats-io/jetstream
                                                                                                                                    @nats-io/jetstream
                                                                                                                                      Preparing search index...
                                                                                                                                      Type Alias BatchMessageOptions
                                                                                                                                      BatchMessageOptions: Partial<Omit<JetStreamPublishOptions, "msgID" | "expect">> & {
                                                                                                                                          expect?: Partial<Omit<StreamExpectations, "lastMsgID">>;
                                                                                                                                      }
                                                                                                                                      Settings
                                                                                                                                      Member Visibility
                                                                                                                                      
diff --git a/docs/jetstream/types/BatchMessageOptionsWithReply.html b/docs/jetstream/types/BatchMessageOptionsWithReply.html
new file mode 100644
index 00000000..4989eb31
--- /dev/null
+++ b/docs/jetstream/types/BatchMessageOptionsWithReply.html
@@ -0,0 +1,3 @@
+BatchMessageOptionsWithReply | @nats-io/jetstream
                                                                                                                                      @nats-io/jetstream
                                                                                                                                        Preparing search index...
                                                                                                                                        Type Alias BatchMessageOptionsWithReply
                                                                                                                                        BatchMessageOptionsWithReply: { ack: boolean } & Partial<BatchMessageOptions>
                                                                                                                                        Type declaration
                                                                                                                                        • ack: boolean
                                                                                                                                          Request acknowledgement of the message (only set this on some of the
+messages, as this introduces a round trip to the server)
                                                                                                                                          
+
                                                                                                                                        Settings
                                                                                                                                        Member Visibility
                                                                                                                                        
diff --git a/docs/jetstream/types/Bind.html b/docs/jetstream/types/Bind.html
index 3b257462..e46a204a 100644
--- a/docs/jetstream/types/Bind.html
+++ b/docs/jetstream/types/Bind.html
@@ -1,6 +1,6 @@
-Bind | @nats-io/jetstream
                                                                                                                                        @nats-io/jetstream
                                                                                                                                          Preparing search index...
                                                                                                                                          Type Alias Bind
                                                                                                                                          type Bind = {
                                                                                                                                              bind?: boolean;
                                                                                                                                          }
                                                                                                                                          Index
                                                                                                                                          Properties
                                                                                                                                          bind?
+Bind | @nats-io/jetstream
                                                                                                                                          @nats-io/jetstream
                                                                                                                                            Preparing search index...
                                                                                                                                            Type Alias Bind
                                                                                                                                            type Bind = {
                                                                                                                                                bind?: boolean;
                                                                                                                                            }
                                                                                                                                            Index
                                                                                                                                            Properties
                                                                                                                                            bind?
 
                                                                                                                                            Properties
                                                                                                                                            bind?: boolean
                                                                                                                                            If set to true the client will not try to check on its consumer by issuing consumer info
 requests. This means that the client may not report consumer not found, etc., and will simply
 fail request for messages due to missed heartbeats. This option is exclusive of abort_on_missing_resource.
                                                                                                                                            
 
                                                                                                                                            This option is not valid on ordered consumers.
                                                                                                                                            
-
                                                                                                                                            Settings
                                                                                                                                            Member Visibility
                                                                                                                                            On This Page
                                                                                                                                            Properties
                                                                                                                                            
+
                                                                                                                                            Settings
                                                                                                                                            Member Visibility
                                                                                                                                            On This Page
                                                                                                                                            Properties
                                                                                                                                            
diff --git a/docs/jetstream/types/BoundPushConsumerOptions.html b/docs/jetstream/types/BoundPushConsumerOptions.html
index 5e3a5d85..e7d10bd8 100644
--- a/docs/jetstream/types/BoundPushConsumerOptions.html
+++ b/docs/jetstream/types/BoundPushConsumerOptions.html
@@ -7,4 +7,4 @@
 This value starts a client-side timer to detect missing heartbeats.
 If not specified or values don't match, there will be a skew and
 the possibility of false heartbeat missed notifications.
                                                                                                                                            
-
                                                                                                                                            Settings
                                                                                                                                            Member Visibility
                                                                                                                                            
+
                                                                                                                                            Settings
                                                                                                                                            Member Visibility
                                                                                                                                            
diff --git a/docs/jetstream/types/Close.html b/docs/jetstream/types/Close.html
index 8d0b0690..c8927ed8 100644
--- a/docs/jetstream/types/Close.html
+++ b/docs/jetstream/types/Close.html
@@ -1,3 +1,3 @@
-Close | @nats-io/jetstream
                                                                                                                                            @nats-io/jetstream
                                                                                                                                              Preparing search index...
                                                                                                                                              Type Alias Close
                                                                                                                                              type Close = {
                                                                                                                                                  close(): Promise<void | Error>;
                                                                                                                                                  closed(): Promise<void | Error>;
                                                                                                                                              }
                                                                                                                                              Index
                                                                                                                                              Methods
                                                                                                                                              close
+Close | @nats-io/jetstream
                                                                                                                                              @nats-io/jetstream
                                                                                                                                                Preparing search index...
                                                                                                                                                Type Alias Close
                                                                                                                                                type Close = {
                                                                                                                                                    close(): Promise<void | Error>;
                                                                                                                                                    closed(): Promise<void | Error>;
                                                                                                                                                }
                                                                                                                                                Index
                                                                                                                                                Methods
                                                                                                                                                close
 closed
-
                                                                                                                                                Methods
                                                                                                                                                • Returns Promise<void | Error>
                                                                                                                                                • Returns Promise<void | Error>
                                                                                                                                                Settings
                                                                                                                                                Member Visibility
                                                                                                                                                On This Page
                                                                                                                                                Methods
                                                                                                                                                
+
                                                                                                                                                Methods
                                                                                                                                                • Returns Promise<void | Error>
                                                                                                                                                • Returns Promise<void | Error>
                                                                                                                                                Settings
                                                                                                                                                Member Visibility
                                                                                                                                                On This Page
                                                                                                                                                Methods
                                                                                                                                                
diff --git a/docs/jetstream/types/Closed.html b/docs/jetstream/types/Closed.html
index 58511dc9..4ecee693 100644
--- a/docs/jetstream/types/Closed.html
+++ b/docs/jetstream/types/Closed.html
@@ -1,5 +1,5 @@
 Closed | @nats-io/jetstream
                                                                                                                                                @nats-io/jetstream
                                                                                                                                                  Preparing search index...
                                                                                                                                                  Type Alias Closed
                                                                                                                                                  A type that reports via a promise when an object such as a connection
 or subscription closes.
                                                                                                                                                  
-
                                                                                                                                                  type Closed = {
                                                                                                                                                      closed: Promise<void>;
                                                                                                                                                  }
                                                                                                                                                  Index
                                                                                                                                                  Properties
                                                                                                                                                  closed
+
                                                                                                                                                  type Closed = {
                                                                                                                                                      closed: Promise<void>;
                                                                                                                                                  }
                                                                                                                                                  Index
                                                                                                                                                  Properties
                                                                                                                                                  closed
 
                                                                                                                                                  Properties
                                                                                                                                                  closed: Promise<void>
                                                                                                                                                  A promise that when resolves, indicates that the object is closed.
                                                                                                                                                  
-
                                                                                                                                                  Settings
                                                                                                                                                  Member Visibility
                                                                                                                                                  On This Page
                                                                                                                                                  Properties
                                                                                                                                                  
+
                                                                                                                                                  Settings
                                                                                                                                                  Member Visibility
                                                                                                                                                  On This Page
                                                                                                                                                  Properties
                                                                                                                                                  
diff --git a/docs/jetstream/types/ClusterInfo.html b/docs/jetstream/types/ClusterInfo.html
index a83ca9a6..3101702c 100644
--- a/docs/jetstream/types/ClusterInfo.html
+++ b/docs/jetstream/types/ClusterInfo.html
@@ -1,7 +1,15 @@
-ClusterInfo | @nats-io/jetstream
                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                    Preparing search index...
                                                                                                                                                    Type Alias ClusterInfo
                                                                                                                                                    type ClusterInfo = {
                                                                                                                                                        leader?: string;
                                                                                                                                                        name?: string;
                                                                                                                                                        replicas?: PeerInfo[];
                                                                                                                                                    }
                                                                                                                                                    Index
                                                                                                                                                    Properties
                                                                                                                                                    leader?
+ClusterInfo | @nats-io/jetstream
                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                      Preparing search index...
                                                                                                                                                      Type Alias ClusterInfo
                                                                                                                                                      type ClusterInfo = {
                                                                                                                                                          leader?: string;
                                                                                                                                                          leader_since?: string;
                                                                                                                                                          name?: string;
                                                                                                                                                          raft_group?: string;
                                                                                                                                                          replicas?: PeerInfo[];
                                                                                                                                                          system_account?: boolean;
                                                                                                                                                          traffic_account?: string;
                                                                                                                                                      }
                                                                                                                                                      Index
                                                                                                                                                      Properties
                                                                                                                                                      leader?
+leader_since?
 name?
+raft_group?
 replicas?
+system_account?
+traffic_account?
 
                                                                                                                                                      Properties
                                                                                                                                                      leader?: string
                                                                                                                                                      The server name of the RAFT leader
                                                                                                                                                      
-
                                                                                                                                                      name?: string
                                                                                                                                                      The cluster name
                                                                                                                                                      
-
                                                                                                                                                      replicas?: PeerInfo[]
                                                                                                                                                      The members of the RAFT cluster
                                                                                                                                                      
-
                                                                                                                                                      Settings
                                                                                                                                                      Member Visibility
                                                                                                                                                      On This Page
                                                                                                                                                      Properties
                                                                                                                                                      
+
                                                                                                                                                      leader_since?: string
                                                                                                                                                      The ISO timestamp when the RAFT leader was elected.
                                                                                                                                                      
+
                                                                                                                                                      name?: string
                                                                                                                                                      The cluster name
                                                                                                                                                      
+
                                                                                                                                                      raft_group?: string
                                                                                                                                                      Name of the raft group managing the asset
                                                                                                                                                      
+
                                                                                                                                                      replicas?: PeerInfo[]
                                                                                                                                                      The members of the RAFT cluster
                                                                                                                                                      
+
                                                                                                                                                      system_account?: boolean
                                                                                                                                                      True if the traffic_account is a system account
                                                                                                                                                      
+
                                                                                                                                                      traffic_account?: string
                                                                                                                                                      The account through which the cluster traffic flows through
                                                                                                                                                      
+
                                                                                                                                                      Settings
                                                                                                                                                      Member Visibility
                                                                                                                                                      On This Page
                                                                                                                                                      Properties
                                                                                                                                                      
diff --git a/docs/jetstream/types/CompletionResult.html b/docs/jetstream/types/CompletionResult.html
index 95817d17..aa673270 100644
--- a/docs/jetstream/types/CompletionResult.html
+++ b/docs/jetstream/types/CompletionResult.html
@@ -1,2 +1,2 @@
-CompletionResult | @nats-io/jetstream
                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                        Preparing search index...
                                                                                                                                                        Type Alias CompletionResult
                                                                                                                                                        type CompletionResult = {
                                                                                                                                                            err?: Error;
                                                                                                                                                        }
                                                                                                                                                        Index
                                                                                                                                                        Properties
                                                                                                                                                        err?
-
                                                                                                                                                        Properties
                                                                                                                                                        err?: Error
                                                                                                                                                        Settings
                                                                                                                                                        Member Visibility
                                                                                                                                                        On This Page
                                                                                                                                                        Properties
                                                                                                                                                        
+CompletionResult | @nats-io/jetstream
                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                          Preparing search index...
                                                                                                                                                          Type Alias CompletionResult
                                                                                                                                                          type CompletionResult = {
                                                                                                                                                              err?: Error;
                                                                                                                                                          }
                                                                                                                                                          Index
                                                                                                                                                          Properties
                                                                                                                                                          err?
+
                                                                                                                                                          Properties
                                                                                                                                                          err?: Error
                                                                                                                                                          Settings
                                                                                                                                                          Member Visibility
                                                                                                                                                          On This Page
                                                                                                                                                          Properties
                                                                                                                                                          
diff --git a/docs/jetstream/types/ConsumeBytes.html b/docs/jetstream/types/ConsumeBytes.html
index 4ddb5726..41ae43f9 100644
--- a/docs/jetstream/types/ConsumeBytes.html
+++ b/docs/jetstream/types/ConsumeBytes.html
@@ -1 +1 @@
-ConsumeBytes | @nats-io/jetstream
                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                            Preparing search index...
                                                                                                                                                            Type Alias ConsumeBytes
                                                                                                                                                            ConsumeBytes: MaxBytes & Partial<MaxMessages> & Partial<ThresholdBytes> & Expires & IdleHeartbeat & ConsumeCallback & AbortOnMissingResource & Bind & Partial<
                                                                                                                                                                OverflowOptions,
                                                                                                                                                            >
                                                                                                                                                            Settings
                                                                                                                                                            Member Visibility
                                                                                                                                                            
+ConsumeBytes | @nats-io/jetstream
                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                              Preparing search index...
                                                                                                                                                              Type Alias ConsumeBytes
                                                                                                                                                              ConsumeBytes: MaxBytes & Partial<MaxMessages> & Partial<ThresholdBytes> & Expires & IdleHeartbeat & ConsumeCallback & AbortOnMissingResource & Bind & Partial<
                                                                                                                                                                  OverflowOptions,
                                                                                                                                                              > & Partial<PrioritizedOptions>
                                                                                                                                                              Settings
                                                                                                                                                              Member Visibility
                                                                                                                                                              
diff --git a/docs/jetstream/types/ConsumeCallback.html b/docs/jetstream/types/ConsumeCallback.html
index 2447118a..cba9cd28 100644
--- a/docs/jetstream/types/ConsumeCallback.html
+++ b/docs/jetstream/types/ConsumeCallback.html
@@ -1,5 +1,5 @@
-ConsumeCallback | @nats-io/jetstream
                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                Preparing search index...
                                                                                                                                                                Type Alias ConsumeCallback
                                                                                                                                                                type ConsumeCallback = {
                                                                                                                                                                    callback?: ConsumerCallbackFn;
                                                                                                                                                                }
                                                                                                                                                                Index
                                                                                                                                                                Properties
                                                                                                                                                                callback?
+ConsumeCallback | @nats-io/jetstream
                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                  Preparing search index...
                                                                                                                                                                  Type Alias ConsumeCallback
                                                                                                                                                                  type ConsumeCallback = {
                                                                                                                                                                      callback?: ConsumerCallbackFn;
                                                                                                                                                                  }
                                                                                                                                                                  Index
                                                                                                                                                                  Properties
                                                                                                                                                                  callback?
 
                                                                                                                                                                  Properties
                                                                                                                                                                  callback?: ConsumerCallbackFn
                                                                                                                                                                  Process messages using a callback instead of an iterator. Note that when using callbacks,
 the callback cannot be async. If you must use async functionality, process messages
 using an iterator.
                                                                                                                                                                  
-
                                                                                                                                                                  Settings
                                                                                                                                                                  Member Visibility
                                                                                                                                                                  On This Page
                                                                                                                                                                  Properties
                                                                                                                                                                  
+
                                                                                                                                                                  Settings
                                                                                                                                                                  Member Visibility
                                                                                                                                                                  On This Page
                                                                                                                                                                  Properties
                                                                                                                                                                  
diff --git a/docs/jetstream/types/ConsumeMessages.html b/docs/jetstream/types/ConsumeMessages.html
index 41af2e13..4f47f695 100644
--- a/docs/jetstream/types/ConsumeMessages.html
+++ b/docs/jetstream/types/ConsumeMessages.html
@@ -1 +1 @@
-ConsumeMessages | @nats-io/jetstream
                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                    Preparing search index...
                                                                                                                                                                    Type Alias ConsumeMessages
                                                                                                                                                                    ConsumeMessages: Partial<MaxMessages> & Partial<ThresholdMessages> & Expires & IdleHeartbeat & ConsumeCallback & AbortOnMissingResource & Bind & Partial<
                                                                                                                                                                        OverflowOptions,
                                                                                                                                                                    >
                                                                                                                                                                    Settings
                                                                                                                                                                    Member Visibility
                                                                                                                                                                    
+ConsumeMessages | @nats-io/jetstream
                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                      Preparing search index...
                                                                                                                                                                      Type Alias ConsumeMessages
                                                                                                                                                                      ConsumeMessages: Partial<MaxMessages> & Partial<ThresholdMessages> & Expires & IdleHeartbeat & ConsumeCallback & AbortOnMissingResource & Bind & Partial<
                                                                                                                                                                          OverflowOptions,
                                                                                                                                                                      > & Partial<PrioritizedOptions>
                                                                                                                                                                      Settings
                                                                                                                                                                      Member Visibility
                                                                                                                                                                      
diff --git a/docs/jetstream/types/ConsumeOptions.html b/docs/jetstream/types/ConsumeOptions.html
index fc765e86..de006db4 100644
--- a/docs/jetstream/types/ConsumeOptions.html
+++ b/docs/jetstream/types/ConsumeOptions.html
@@ -1 +1 @@
-ConsumeOptions | @nats-io/jetstream
                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                        Preparing search index...
                                                                                                                                                                        Type Alias ConsumeOptions
                                                                                                                                                                        ConsumeOptions: ConsumeBytes | ConsumeMessages
                                                                                                                                                                        Settings
                                                                                                                                                                        Member Visibility
                                                                                                                                                                        
+ConsumeOptions | @nats-io/jetstream
                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                          Preparing search index...
                                                                                                                                                                          Type Alias ConsumeOptions
                                                                                                                                                                          ConsumeOptions: ConsumeBytes | ConsumeMessages
                                                                                                                                                                          Settings
                                                                                                                                                                          Member Visibility
                                                                                                                                                                          
diff --git a/docs/jetstream/types/Consumer.html b/docs/jetstream/types/Consumer.html
index f0ad9944..e6a3c96a 100644
--- a/docs/jetstream/types/Consumer.html
+++ b/docs/jetstream/types/Consumer.html
@@ -1 +1 @@
-Consumer | @nats-io/jetstream
                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                            Preparing search index...
                                                                                                                                                                            Type Alias Consumer
                                                                                                                                                                            Consumer: ExportedConsumer & InfoableConsumer & DeleteableConsumer
                                                                                                                                                                            Settings
                                                                                                                                                                            Member Visibility
                                                                                                                                                                            
+Consumer | @nats-io/jetstream
                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                              Preparing search index...
                                                                                                                                                                              Type Alias Consumer
                                                                                                                                                                              Consumer: ExportedConsumer & InfoableConsumer & DeleteableConsumer
                                                                                                                                                                              Settings
                                                                                                                                                                              Member Visibility
                                                                                                                                                                              
diff --git a/docs/jetstream/types/ConsumerAPI.html b/docs/jetstream/types/ConsumerAPI.html
index 030b12fc..1a5f14f4 100644
--- a/docs/jetstream/types/ConsumerAPI.html
+++ b/docs/jetstream/types/ConsumerAPI.html
@@ -1,4 +1,4 @@
-ConsumerAPI | @nats-io/jetstream
                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                Type Alias ConsumerAPI
                                                                                                                                                                                type ConsumerAPI = {
                                                                                                                                                                                    add(
                                                                                                                                                                                        stream: string,
                                                                                                                                                                                        cfg: Partial<ConsumerConfig>,
                                                                                                                                                                                        opts?: ConsumerCreateOptions,
                                                                                                                                                                                    ): Promise<ConsumerInfo>;
                                                                                                                                                                                    delete(stream: string, consumer: string): Promise<boolean>;
                                                                                                                                                                                    info(stream: string, consumer: string): Promise<ConsumerInfo>;
                                                                                                                                                                                    list(stream: string): Lister<ConsumerInfo>;
                                                                                                                                                                                    pause(
                                                                                                                                                                                        stream: string,
                                                                                                                                                                                        name: string,
                                                                                                                                                                                        until?: Date,
                                                                                                                                                                                    ): Promise<{ pause_until?: string; paused: boolean }>;
                                                                                                                                                                                    resume(
                                                                                                                                                                                        stream: string,
                                                                                                                                                                                        name: string,
                                                                                                                                                                                    ): Promise<{ pause_until?: string; paused: boolean }>;
                                                                                                                                                                                    unpin(stream: string, name: string, group: string): Promise<void>;
                                                                                                                                                                                    update(
                                                                                                                                                                                        stream: string,
                                                                                                                                                                                        durable: string,
                                                                                                                                                                                        cfg: Partial<ConsumerUpdateConfig>,
                                                                                                                                                                                    ): Promise<ConsumerInfo>;
                                                                                                                                                                                }
                                                                                                                                                                                Index
                                                                                                                                                                                Methods
                                                                                                                                                                                add
+ConsumerAPI | @nats-io/jetstream
                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                  Type Alias ConsumerAPI
                                                                                                                                                                                  type ConsumerAPI = {
                                                                                                                                                                                      add(
                                                                                                                                                                                          stream: string,
                                                                                                                                                                                          cfg: Partial<ConsumerConfig>,
                                                                                                                                                                                          opts?: ConsumerCreateOptions,
                                                                                                                                                                                      ): Promise<ConsumerInfo>;
                                                                                                                                                                                      delete(stream: string, consumer: string): Promise<boolean>;
                                                                                                                                                                                      info(stream: string, consumer: string): Promise<ConsumerInfo>;
                                                                                                                                                                                      list(stream: string): Lister<ConsumerInfo>;
                                                                                                                                                                                      pause(
                                                                                                                                                                                          stream: string,
                                                                                                                                                                                          name: string,
                                                                                                                                                                                          until?: Date,
                                                                                                                                                                                      ): Promise<{ pause_until?: string; paused: boolean }>;
                                                                                                                                                                                      resume(
                                                                                                                                                                                          stream: string,
                                                                                                                                                                                          name: string,
                                                                                                                                                                                      ): Promise<{ pause_until?: string; paused: boolean }>;
                                                                                                                                                                                      unpin(stream: string, name: string, group: string): Promise<void>;
                                                                                                                                                                                      update(
                                                                                                                                                                                          stream: string,
                                                                                                                                                                                          durable: string,
                                                                                                                                                                                          cfg: Partial<ConsumerUpdateConfig>,
                                                                                                                                                                                      ): Promise<ConsumerInfo>;
                                                                                                                                                                                  }
                                                                                                                                                                                  Index
                                                                                                                                                                                  Methods
                                                                                                                                                                                  add
 delete
 info
 list
@@ -7,13 +7,13 @@
 unpin
 update
 
                                                                                                                                                                                  Methods
                                                                                                                                                                                  • Deletes the specified consumer name/durable from the specified stream.
                                                                                                                                                                                    
-
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • consumer: string
                                                                                                                                                                                    Returns Promise<boolean>
                                                                                                                                                                                  • Returns the ConsumerInfo for the specified consumer in the specified stream.
                                                                                                                                                                                    
-
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • consumer: string
                                                                                                                                                                                    Returns Promise<ConsumerInfo>
                                                                                                                                                                                  • Lists all the consumers on the specified streams
                                                                                                                                                                                    
-
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    Returns Lister<ConsumerInfo>
                                                                                                                                                                                  • Pauses the consumer until the specified Date
                                                                                                                                                                                    
-
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • name: string
                                                                                                                                                                                    • Optionaluntil: Date
                                                                                                                                                                                    Returns Promise<{ pause_until?: string; paused: boolean }>
                                                                                                                                                                                  • Resumes a paused Consumer, returning whether it is
+
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    Returns Promise<ConsumerInfo>
                                                                                                                                                                                  • Deletes the specified consumer name/durable from the specified stream.
                                                                                                                                                                                    
+
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • consumer: string
                                                                                                                                                                                    Returns Promise<boolean>
                                                                                                                                                                                  • Returns the ConsumerInfo for the specified consumer in the specified stream.
                                                                                                                                                                                    
+
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • consumer: string
                                                                                                                                                                                    Returns Promise<ConsumerInfo>
                                                                                                                                                                                  • Lists all the consumers on the specified streams
                                                                                                                                                                                    
+
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    Returns Lister<ConsumerInfo>
                                                                                                                                                                                  • Pauses the consumer until the specified Date
                                                                                                                                                                                    
+
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • name: string
                                                                                                                                                                                    • Optionaluntil: Date
                                                                                                                                                                                    Returns Promise<{ pause_until?: string; paused: boolean }>
                                                                                                                                                                                  • Resumes a paused Consumer, returning whether it is
 paused and when it will resume.
                                                                                                                                                                                    
-
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • name: string
                                                                                                                                                                                    Returns Promise<{ pause_until?: string; paused: boolean }>
                                                                                                                                                                                  • Unpins the currently pinned consumer.
                                                                                                                                                                                    
-
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • name: string
                                                                                                                                                                                    • group: string
                                                                                                                                                                                    Returns Promise<void>
                                                                                                                                                                                  • Updates the consumer configuration for the specified consumer on the specified
+
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • name: string
                                                                                                                                                                                    Returns Promise<{ pause_until?: string; paused: boolean }>
                                                                                                                                                                                  • Unpins the currently pinned consumer.
                                                                                                                                                                                    
+
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    • stream: string
                                                                                                                                                                                    • name: string
                                                                                                                                                                                    • group: string
                                                                                                                                                                                    Returns Promise<void>
                                                                                                                                                                                  • Updates the consumer configuration for the specified consumer on the specified
 stream that has the specified durable name.
                                                                                                                                                                                    
-
                                                                                                                                                                                    Parameters
                                                                                                                                                                                    Returns Promise<ConsumerInfo>
                                                                                                                                                                                  Settings
                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                  On This Page
                                                                                                                                                                                  Methods
                                                                                                                                                                                  
+
                                                                                                                                                                                  Parameters
                                                                                                                                                                                  Returns Promise<ConsumerInfo>
                                                                                                                                                                                  Settings
                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                  On This Page
                                                                                                                                                                                  Methods
                                                                                                                                                                                  
diff --git a/docs/jetstream/types/ConsumerCallbackFn.html b/docs/jetstream/types/ConsumerCallbackFn.html
index d448b7e0..0ad53986 100644
--- a/docs/jetstream/types/ConsumerCallbackFn.html
+++ b/docs/jetstream/types/ConsumerCallbackFn.html
@@ -1 +1 @@
-ConsumerCallbackFn | @nats-io/jetstream
                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                    Type Alias ConsumerCallbackFn
                                                                                                                                                                                    ConsumerCallbackFn: (r: JsMsg) => void | Promise<never>
                                                                                                                                                                                    Type declaration
                                                                                                                                                                                      • (r: JsMsg): void | Promise<never>
                                                                                                                                                                                      • Parameters
                                                                                                                                                                                        Returns void | Promise<never>
                                                                                                                                                                                    Settings
                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                    
+ConsumerCallbackFn | @nats-io/jetstream
                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                      Type Alias ConsumerCallbackFn
                                                                                                                                                                                      ConsumerCallbackFn: (r: JsMsg) => void | Promise<never>
                                                                                                                                                                                      Type declaration
                                                                                                                                                                                        • (r: JsMsg): void | Promise<never>
                                                                                                                                                                                        • Parameters
                                                                                                                                                                                          Returns void | Promise<never>
                                                                                                                                                                                      Settings
                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                      
diff --git a/docs/jetstream/types/ConsumerConfig.html b/docs/jetstream/types/ConsumerConfig.html
index 02d23bff..42efd421 100644
--- a/docs/jetstream/types/ConsumerConfig.html
+++ b/docs/jetstream/types/ConsumerConfig.html
@@ -1,7 +1,7 @@
 ConsumerConfig | @nats-io/jetstream
                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                        Type Alias ConsumerConfig
                                                                                                                                                                                        ConsumerConfig: ConsumerUpdateConfig & {
                                                                                                                                                                                            ack_policy: AckPolicy;
                                                                                                                                                                                            deliver_group?: string;
                                                                                                                                                                                            deliver_policy: DeliverPolicy;
                                                                                                                                                                                            durable_name?: string;
                                                                                                                                                                                            flow_control?: boolean;
                                                                                                                                                                                            idle_heartbeat?: Nanos;
                                                                                                                                                                                            name?: string;
                                                                                                                                                                                            opt_start_seq?: number;
                                                                                                                                                                                            opt_start_time?: string;
                                                                                                                                                                                            pause_until?: string;
                                                                                                                                                                                            rate_limit_bps?: number;
                                                                                                                                                                                            replay_policy: ReplayPolicy;
                                                                                                                                                                                        }
                                                                                                                                                                                        Type declaration
                                                                                                                                                                                        • ack_policy: AckPolicy
                                                                                                                                                                                          The type of acknowledgment required by the Consumer
                                                                                                                                                                                          
 
                                                                                                                                                                                        • Optionaldeliver_group?: string
                                                                                                                                                                                          Allows push consumers to form a queue group
                                                                                                                                                                                          
 
                                                                                                                                                                                        • deliver_policy: DeliverPolicy
                                                                                                                                                                                          Where to start consuming messages on the stream
                                                                                                                                                                                          
-
                                                                                                                                                                                        • Optionaldurable_name?: string
                                                                                                                                                                                          A unique name for a durable consumer. Set name for ephemeral consumers
                                                                                                                                                                                          
+
                                                                                                                                                                                        • Optionaldurable_name?: string
                                                                                                                                                                                          A unique name for a durable consumer. Set name for ephemeral consumers
                                                                                                                                                                                          
 
                                                                                                                                                                                        • Optionalflow_control?: boolean
                                                                                                                                                                                          For push consumers this will regularly send an empty mess with Status header 100
 and a reply subject, consumers must reply to these messages to control
 the rate of message delivery.
                                                                                                                                                                                          
@@ -16,4 +16,4 @@
 Specified as an ISO date time string (Date#toISOString()).
                                                                                                                                                                                          
 
                                                                                                                                                                                        • Optionalrate_limit_bps?: number
                                                                                                                                                                                          The rate at which messages will be delivered to clients, expressed in bytes per second
                                                                                                                                                                                          
 
                                                                                                                                                                                        • replay_policy: ReplayPolicy
                                                                                                                                                                                          How messages are played back to the Consumer
                                                                                                                                                                                          
-
                                                                                                                                                                                        Settings
                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                        
+
                                                                                                                                                                                        Settings
                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                        
diff --git a/docs/jetstream/types/ConsumerCreateOptions.html b/docs/jetstream/types/ConsumerCreateOptions.html
index 35d5e481..93fd3a39 100644
--- a/docs/jetstream/types/ConsumerCreateOptions.html
+++ b/docs/jetstream/types/ConsumerCreateOptions.html
@@ -1,4 +1,4 @@
-ConsumerCreateOptions | @nats-io/jetstream
                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                          Type Alias ConsumerCreateOptions
                                                                                                                                                                                          type ConsumerCreateOptions = {
                                                                                                                                                                                              pedantic?: boolean;
                                                                                                                                                                                          }
                                                                                                                                                                                          Index
                                                                                                                                                                                          Properties
                                                                                                                                                                                          pedantic?
+ConsumerCreateOptions | @nats-io/jetstream
                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                            Type Alias ConsumerCreateOptions
                                                                                                                                                                                            type ConsumerCreateOptions = {
                                                                                                                                                                                                pedantic?: boolean;
                                                                                                                                                                                            }
                                                                                                                                                                                            Index
                                                                                                                                                                                            Properties
                                                                                                                                                                                            pedantic?
 
                                                                                                                                                                                            Properties
                                                                                                                                                                                            pedantic?: boolean
                                                                                                                                                                                            If true, the server will check that the consumer configuration aligns with
 stream settings that affect the consumer.
                                                                                                                                                                                            
-
                                                                                                                                                                                            Settings
                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                            On This Page
                                                                                                                                                                                            Properties
                                                                                                                                                                                            
+
                                                                                                                                                                                            Settings
                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                            On This Page
                                                                                                                                                                                            Properties
                                                                                                                                                                                            
diff --git a/docs/jetstream/types/ConsumerDeleted.html b/docs/jetstream/types/ConsumerDeleted.html
index 97048db1..554c4abc 100644
--- a/docs/jetstream/types/ConsumerDeleted.html
+++ b/docs/jetstream/types/ConsumerDeleted.html
@@ -1,7 +1,7 @@
 ConsumerDeleted | @nats-io/jetstream
                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                              Type Alias ConsumerDeleted
                                                                                                                                                                                              Notification that the consumer was deleted. This notification
 means the consumer will not get messages unless it is recreated. The client
 will continue to attempt to pull messages. Ordered consumer will recreate it.
                                                                                                                                                                                              
-
                                                                                                                                                                                              type ConsumerDeleted = {
                                                                                                                                                                                                  code: number;
                                                                                                                                                                                                  description: string;
                                                                                                                                                                                                  type: "consumer_deleted";
                                                                                                                                                                                              }
                                                                                                                                                                                              Index
                                                                                                                                                                                              Properties
                                                                                                                                                                                              code
+
                                                                                                                                                                                              type ConsumerDeleted = {
                                                                                                                                                                                                  code: number;
                                                                                                                                                                                                  description: string;
                                                                                                                                                                                                  type: "consumer_deleted";
                                                                                                                                                                                              }
                                                                                                                                                                                              Index
                                                                                                                                                                                              Properties
                                                                                                                                                                                              code
 description
 type
-
                                                                                                                                                                                              Properties
                                                                                                                                                                                              code: number
                                                                                                                                                                                              description: string
                                                                                                                                                                                              type: "consumer_deleted"
                                                                                                                                                                                              Settings
                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                              On This Page
                                                                                                                                                                                              Properties
                                                                                                                                                                                              
+
                                                                                                                                                                                              Properties
                                                                                                                                                                                              code: number
                                                                                                                                                                                              description: string
                                                                                                                                                                                              type: "consumer_deleted"
                                                                                                                                                                                              Settings
                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                              On This Page
                                                                                                                                                                                              Properties
                                                                                                                                                                                              
diff --git a/docs/jetstream/types/ConsumerInfo.html b/docs/jetstream/types/ConsumerInfo.html
index 93a4809e..f525f020 100644
--- a/docs/jetstream/types/ConsumerInfo.html
+++ b/docs/jetstream/types/ConsumerInfo.html
@@ -1,4 +1,4 @@
-ConsumerInfo | @nats-io/jetstream
                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                Type Alias ConsumerInfo
                                                                                                                                                                                                type ConsumerInfo = {
                                                                                                                                                                                                    ack_floor: SequenceInfo;
                                                                                                                                                                                                    cluster?: ClusterInfo;
                                                                                                                                                                                                    config: ConsumerConfig;
                                                                                                                                                                                                    created: string;
                                                                                                                                                                                                    delivered: SequenceInfo;
                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                    num_ack_pending: number;
                                                                                                                                                                                                    num_pending: number;
                                                                                                                                                                                                    num_redelivered: number;
                                                                                                                                                                                                    num_waiting: number;
                                                                                                                                                                                                    pause_remaining: Nanos;
                                                                                                                                                                                                    paused?: boolean;
                                                                                                                                                                                                    push_bound: boolean;
                                                                                                                                                                                                    stream_name: string;
                                                                                                                                                                                                    ts?: string;
                                                                                                                                                                                                }
                                                                                                                                                                                                Index
                                                                                                                                                                                                Properties
                                                                                                                                                                                                ack_floor
+ConsumerInfo | @nats-io/jetstream
                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                  Type Alias ConsumerInfo
                                                                                                                                                                                                  type ConsumerInfo = {
                                                                                                                                                                                                      ack_floor: SequenceInfo;
                                                                                                                                                                                                      cluster?: ClusterInfo;
                                                                                                                                                                                                      config: ConsumerConfig;
                                                                                                                                                                                                      created: string;
                                                                                                                                                                                                      delivered: SequenceInfo;
                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                      num_ack_pending: number;
                                                                                                                                                                                                      num_pending: number;
                                                                                                                                                                                                      num_redelivered: number;
                                                                                                                                                                                                      num_waiting: number;
                                                                                                                                                                                                      pause_remaining: Nanos;
                                                                                                                                                                                                      paused?: boolean;
                                                                                                                                                                                                      push_bound: boolean;
                                                                                                                                                                                                      stream_name: string;
                                                                                                                                                                                                      ts?: string;
                                                                                                                                                                                                  }
                                                                                                                                                                                                  Index
                                                                                                                                                                                                  Properties
                                                                                                                                                                                                  ack_floor
 cluster?
 config
 created
@@ -14,23 +14,23 @@
 stream_name
 ts?
 
                                                                                                                                                                                                  Properties
                                                                                                                                                                                                  ack_floor: SequenceInfo
                                                                                                                                                                                                  The highest contiguous acknowledged message
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  cluster?: ClusterInfo
                                                                                                                                                                                                  The cluster where the consumer is defined
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  config: ConsumerConfig
                                                                                                                                                                                                  The consumer configuration
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  created: string
                                                                                                                                                                                                  The ISO timestamp when the Consumer was created
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  delivered: SequenceInfo
                                                                                                                                                                                                  The last message delivered from this Consumer
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  name: string
                                                                                                                                                                                                  A unique name for the consumer, either machine generated or the durable name
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  num_ack_pending: number
                                                                                                                                                                                                  The number of messages pending acknowledgement
+
                                                                                                                                                                                                  cluster?: ClusterInfo
                                                                                                                                                                                                  The cluster where the consumer is defined
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  config: ConsumerConfig
                                                                                                                                                                                                  The consumer configuration
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  created: string
                                                                                                                                                                                                  The ISO timestamp when the Consumer was created
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  delivered: SequenceInfo
                                                                                                                                                                                                  The last message delivered from this Consumer
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  name: string
                                                                                                                                                                                                  A unique name for the consumer, either machine generated or the durable name
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  num_ack_pending: number
                                                                                                                                                                                                  The number of messages pending acknowledgement
 but yet to acknowledged by the client.
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  num_pending: number
                                                                                                                                                                                                  The number of messages left unconsumed in this Consumer
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  num_redelivered: number
                                                                                                                                                                                                  The number of redeliveries that have been performed
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  num_waiting: number
                                                                                                                                                                                                  The number of pull consumers waiting for messages
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  pause_remaining: Nanos
                                                                                                                                                                                                  If the consumer was paused with a resume date, this field specifies the amount of time
+
                                                                                                                                                                                                  num_pending: number
                                                                                                                                                                                                  The number of messages left unconsumed in this Consumer
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  num_redelivered: number
                                                                                                                                                                                                  The number of redeliveries that have been performed
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  num_waiting: number
                                                                                                                                                                                                  The number of pull consumers waiting for messages
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  pause_remaining: Nanos
                                                                                                                                                                                                  If the consumer was paused with a resume date, this field specifies the amount of time
 in nanoseconds remaining until the consumer will be automatically resumed. This field
 is only available on servers 2.11.x or better
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  paused?: boolean
                                                                                                                                                                                                  Set to true if the consumer is paused.
+
                                                                                                                                                                                                  paused?: boolean
                                                                                                                                                                                                  Set to true if the consumer is paused.
 This field is only available on servers 2.11.x or better
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  push_bound: boolean
                                                                                                                                                                                                  Indicates if any client is connected and receiving messages from a push consumer
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  stream_name: string
                                                                                                                                                                                                  The stream hosting the consumer
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  ts?: string
                                                                                                                                                                                                  The ISO timestamp when the ConsumerInfo was generated. This field is only available
+
                                                                                                                                                                                                  push_bound: boolean
                                                                                                                                                                                                  Indicates if any client is connected and receiving messages from a push consumer
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  stream_name: string
                                                                                                                                                                                                  The stream hosting the consumer
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  ts?: string
                                                                                                                                                                                                  The ISO timestamp when the ConsumerInfo was generated. This field is only available
 on servers 2.10.x or better
                                                                                                                                                                                                  
-
                                                                                                                                                                                                  Settings
                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                  On This Page
                                                                                                                                                                                                  Properties
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  Settings
                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                  On This Page
                                                                                                                                                                                                  Properties
                                                                                                                                                                                                  
diff --git a/docs/jetstream/types/ConsumerKind.html b/docs/jetstream/types/ConsumerKind.html
index a7c72c0f..78b65041 100644
--- a/docs/jetstream/types/ConsumerKind.html
+++ b/docs/jetstream/types/ConsumerKind.html
@@ -1,3 +1,3 @@
-ConsumerKind | @nats-io/jetstream
                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                    Type Alias ConsumerKind
                                                                                                                                                                                                    type ConsumerKind = {
                                                                                                                                                                                                        isPullConsumer(): boolean;
                                                                                                                                                                                                        isPushConsumer(): boolean;
                                                                                                                                                                                                    }
                                                                                                                                                                                                    Index
                                                                                                                                                                                                    Methods
                                                                                                                                                                                                    isPullConsumer
+ConsumerKind | @nats-io/jetstream
                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                      Type Alias ConsumerKind
                                                                                                                                                                                                      type ConsumerKind = {
                                                                                                                                                                                                          isPullConsumer(): boolean;
                                                                                                                                                                                                          isPushConsumer(): boolean;
                                                                                                                                                                                                      }
                                                                                                                                                                                                      Index
                                                                                                                                                                                                      Methods
                                                                                                                                                                                                      isPullConsumer
 isPushConsumer
-
                                                                                                                                                                                                      Methods
                                                                                                                                                                                                      • Returns boolean
                                                                                                                                                                                                      • Returns boolean
                                                                                                                                                                                                      Settings
                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                      On This Page
                                                                                                                                                                                                      Methods
                                                                                                                                                                                                      
+
                                                                                                                                                                                                      Methods
                                                                                                                                                                                                      • Returns boolean
                                                                                                                                                                                                      • Returns boolean
                                                                                                                                                                                                      Settings
                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                      On This Page
                                                                                                                                                                                                      Methods
                                                                                                                                                                                                      
diff --git a/docs/jetstream/types/ConsumerMessages.html b/docs/jetstream/types/ConsumerMessages.html
index 1cd8fbcb..bc5cf0d9 100644
--- a/docs/jetstream/types/ConsumerMessages.html
+++ b/docs/jetstream/types/ConsumerMessages.html
@@ -1 +1 @@
-ConsumerMessages | @nats-io/jetstream
                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                        Type Alias ConsumerMessages
                                                                                                                                                                                                        ConsumerMessages: QueuedIterator<JsMsg> & Close & {
                                                                                                                                                                                                            status(): AsyncIterable<ConsumerNotification>;
                                                                                                                                                                                                        }
                                                                                                                                                                                                        Settings
                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                        
+ConsumerMessages | @nats-io/jetstream
                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                          Type Alias ConsumerMessages
                                                                                                                                                                                                          ConsumerMessages: QueuedIterator<JsMsg> & Close & {
                                                                                                                                                                                                              status(): AsyncIterable<ConsumerNotification>;
                                                                                                                                                                                                          }
                                                                                                                                                                                                          Settings
                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                          
diff --git a/docs/jetstream/types/ConsumerNotFound.html b/docs/jetstream/types/ConsumerNotFound.html
index 45624be6..08e19de0 100644
--- a/docs/jetstream/types/ConsumerNotFound.html
+++ b/docs/jetstream/types/ConsumerNotFound.html
@@ -4,8 +4,8 @@
 find the consumer. Note that if you get this notification possibly your code should
 attempt to recreate the consumer. Note that this notification is only informational
 for ordered consumers, as the consumer will be created in those cases automatically.
                                                                                                                                                                                                          
-
                                                                                                                                                                                                          type ConsumerNotFound = {
                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                              stream: string;
                                                                                                                                                                                                              type: "consumer_not_found";
                                                                                                                                                                                                          }
                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          count +
                                                                                                                                                                                                          type ConsumerNotFound = {
                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                              stream: string;
                                                                                                                                                                                                              type: "consumer_not_found";
                                                                                                                                                                                                          }
                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          count name stream type -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          count: number
                                                                                                                                                                                                          name: string
                                                                                                                                                                                                          stream: string
                                                                                                                                                                                                          type: "consumer_not_found"

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          count: number
                                                                                                                                                                                                          name: string
                                                                                                                                                                                                          stream: string
                                                                                                                                                                                                          type: "consumer_not_found"

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          diff --git a/docs/jetstream/types/ConsumerNotification.html b/docs/jetstream/types/ConsumerNotification.html index 20cf2fad..1b71ca76 100644 --- a/docs/jetstream/types/ConsumerNotification.html +++ b/docs/jetstream/types/ConsumerNotification.html @@ -1,3 +1,3 @@ ConsumerNotification | @nats-io/jetstream
                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Type Alias ConsumerNotification

                                                                                                                                                                                                            ConsumerNotification:
                                                                                                                                                                                                                | HeartbeatsMissed
                                                                                                                                                                                                                | ConsumerNotFound
                                                                                                                                                                                                                | StreamNotFound
                                                                                                                                                                                                                | ConsumerDeleted
                                                                                                                                                                                                                | OrderedConsumerRecreated
                                                                                                                                                                                                                | ExceededLimits
                                                                                                                                                                                                                | Debug
                                                                                                                                                                                                                | Discard
                                                                                                                                                                                                                | Reset
                                                                                                                                                                                                                | Next
                                                                                                                                                                                                                | Heartbeat
                                                                                                                                                                                                                | FlowControl
                                                                                                                                                                                                                | NoResponders
                                                                                                                                                                                                                | ConsumerPinned
                                                                                                                                                                                                                | ConsumerUnpinned

                                                                                                                                                                                                            ConsumerNotifications are informational notifications emitted by ConsumerMessages that may be of interest to a client.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                            diff --git a/docs/jetstream/types/ConsumerPinned.html b/docs/jetstream/types/ConsumerPinned.html index 7bea25d6..219ffaa9 100644 --- a/docs/jetstream/types/ConsumerPinned.html +++ b/docs/jetstream/types/ConsumerPinned.html @@ -1,3 +1,3 @@ -ConsumerPinned | @nats-io/jetstream
                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Type Alias ConsumerPinned

                                                                                                                                                                                                              type ConsumerPinned = {
                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                  type: "consumer_pinned";
                                                                                                                                                                                                              }
                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              id +ConsumerPinned | @nats-io/jetstream
                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Type Alias ConsumerPinned

                                                                                                                                                                                                                type ConsumerPinned = {
                                                                                                                                                                                                                    id: string;
                                                                                                                                                                                                                    type: "consumer_pinned";
                                                                                                                                                                                                                }
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                id type -

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                id: string
                                                                                                                                                                                                                type: "consumer_pinned"

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                id: string
                                                                                                                                                                                                                type: "consumer_pinned"

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                diff --git a/docs/jetstream/types/ConsumerUnpinned.html b/docs/jetstream/types/ConsumerUnpinned.html index b2e2f134..d869dd64 100644 --- a/docs/jetstream/types/ConsumerUnpinned.html +++ b/docs/jetstream/types/ConsumerUnpinned.html @@ -1,2 +1,2 @@ -ConsumerUnpinned | @nats-io/jetstream
                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Type Alias ConsumerUnpinned

                                                                                                                                                                                                                  type ConsumerUnpinned = {
                                                                                                                                                                                                                      type: "consumer_unpinned";
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  type -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  type: "consumer_unpinned"

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  +ConsumerUnpinned | @nats-io/jetstream
                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Type Alias ConsumerUnpinned

                                                                                                                                                                                                                    type ConsumerUnpinned = {
                                                                                                                                                                                                                        type: "consumer_unpinned";
                                                                                                                                                                                                                    }
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    type +

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    type: "consumer_unpinned"

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                    diff --git a/docs/jetstream/types/ConsumerUpdateConfig.html b/docs/jetstream/types/ConsumerUpdateConfig.html index df69f89d..c0e4a864 100644 --- a/docs/jetstream/types/ConsumerUpdateConfig.html +++ b/docs/jetstream/types/ConsumerUpdateConfig.html @@ -4,9 +4,9 @@
                                                                                                                                                                                                                  • Optionaldeliver_subject?: string

                                                                                                                                                                                                                    The subject where the push consumer should be sent the messages

                                                                                                                                                                                                                  • Optionaldescription?: string

                                                                                                                                                                                                                    A short description of the purpose of this consume

                                                                                                                                                                                                                  • Optionalfilter_subject?: string

                                                                                                                                                                                                                    Deliver only messages that match the subject filter -This is exclusive of filter_subjects

                                                                                                                                                                                                                    +This is exclusive of filter_subjects

                                                                                                                                                                                                                  • Optionalfilter_subjects?: string[]

                                                                                                                                                                                                                    Deliver only messages that match the specified filters. -This is exclusive of filter_subject.

                                                                                                                                                                                                                    +This is exclusive of filter_subject.

                                                                                                                                                                                                                  • Optionalheaders_only?: boolean

                                                                                                                                                                                                                    Delivers only the headers of messages in the stream and not the bodies. Additionally, adds Nats-Msg-Size JsHeaders#MessageSizeHdr header to indicate the size of the removed payload

                                                                                                                                                                                                                    @@ -26,4 +26,4 @@ keys starting with _nats are reserved. This feature only supported on servers 2.10.x and better.

                                                                                                                                                                                                                  • Optionalnum_replicas?: number

                                                                                                                                                                                                                    When set do not inherit the replica count from the stream but specifically set it to this amount.

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    • Settings

                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                    diff --git a/docs/jetstream/types/Consumers.html b/docs/jetstream/types/Consumers.html index a56f86ee..47ca5c06 100644 --- a/docs/jetstream/types/Consumers.html +++ b/docs/jetstream/types/Consumers.html @@ -1,4 +1,4 @@ -Consumers | @nats-io/jetstream
                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Type Alias Consumers

                                                                                                                                                                                                                      type Consumers = {
                                                                                                                                                                                                                          get(
                                                                                                                                                                                                                              stream: string,
                                                                                                                                                                                                                              name?: string | Partial<OrderedConsumerOptions>,
                                                                                                                                                                                                                          ): Promise<Consumer>;
                                                                                                                                                                                                                          getBoundPushConsumer(opts: BoundPushConsumerOptions): Promise<PushConsumer>;
                                                                                                                                                                                                                          getConsumerFromInfo(ci: ConsumerInfo): Consumer;
                                                                                                                                                                                                                          getPushConsumer(
                                                                                                                                                                                                                              stream: string,
                                                                                                                                                                                                                              name?: string | Partial<OrderedPushConsumerOptions>,
                                                                                                                                                                                                                          ): Promise<PushConsumer>;
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                      get +Consumers | @nats-io/jetstream
                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Type Alias Consumers

                                                                                                                                                                                                                        type Consumers = {
                                                                                                                                                                                                                            get(
                                                                                                                                                                                                                                stream: string,
                                                                                                                                                                                                                                name?: string | Partial<OrderedConsumerOptions>,
                                                                                                                                                                                                                            ): Promise<Consumer>;
                                                                                                                                                                                                                            getBoundPushConsumer(opts: BoundPushConsumerOptions): Promise<PushConsumer>;
                                                                                                                                                                                                                            getConsumerFromInfo(ci: ConsumerInfo): Consumer;
                                                                                                                                                                                                                            getPushConsumer(
                                                                                                                                                                                                                                stream: string,
                                                                                                                                                                                                                                name?: string | Partial<OrderedPushConsumerOptions>,
                                                                                                                                                                                                                            ): Promise<PushConsumer>;
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                        get getBoundPushConsumer getConsumerFromInfo getPushConsumer @@ -12,10 +12,10 @@

                                                                                                                                                                                                                        Consumer.

                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                        • stream: string
                                                                                                                                                                                                                        • Optionalname: string | Partial<OrderedConsumerOptions>

                                                                                                                                                                                                                          or OrderedConsumerOptions - if not specified an ordered consumer is created with the specified options.

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                        Returns Promise<Consumer>

                                                                                                                                                                                                                        • Returns a PullConsumer configured for the specified ConsumerInfo. +

                                                                                                                                                                                                                        Returns Promise<Consumer>

                                                                                                                                                                                                                        • Returns a PullConsumer configured for the specified ConsumerInfo. Note this API doesn't create or check that the consumer exists. It simply returns a Consumer that you can use to process messages. This method should only be used when avoiding extra ConsumerInfo. If the underlying consumer doesn't exist, the consumer will raise heartbeat_missed notifications.

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                          Returns Consumer

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                        Returns Consumer

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/Debug.html b/docs/jetstream/types/Debug.html index f98ac935..d9891324 100644 --- a/docs/jetstream/types/Debug.html +++ b/docs/jetstream/types/Debug.html @@ -1,6 +1,6 @@ Debug | @nats-io/jetstream
                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Type Alias Debug

                                                                                                                                                                                                                          DebugEvents are effectively statuses returned by the server that were ignored by the client. The code and description indicate the server specified code and description.

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          type Debug = {
                                                                                                                                                                                                                              code: number;
                                                                                                                                                                                                                              description: string;
                                                                                                                                                                                                                              type: "debug";
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          code +
                                                                                                                                                                                                                          type Debug = {
                                                                                                                                                                                                                              code: number;
                                                                                                                                                                                                                              description: string;
                                                                                                                                                                                                                              type: "debug";
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          code description type -

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          code: number
                                                                                                                                                                                                                          description: string
                                                                                                                                                                                                                          type: "debug"

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          code: number
                                                                                                                                                                                                                          description: string
                                                                                                                                                                                                                          type: "debug"

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/DeleteableConsumer.html b/docs/jetstream/types/DeleteableConsumer.html index d0d14f6c..e9dd032d 100644 --- a/docs/jetstream/types/DeleteableConsumer.html +++ b/docs/jetstream/types/DeleteableConsumer.html @@ -1,2 +1,2 @@ -DeleteableConsumer | @nats-io/jetstream
                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Type Alias DeleteableConsumer

                                                                                                                                                                                                                            type DeleteableConsumer = {
                                                                                                                                                                                                                                delete(): Promise<boolean>;
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                            delete -

                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                            • Returns Promise<boolean>

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                            +DeleteableConsumer | @nats-io/jetstream
                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Type Alias DeleteableConsumer

                                                                                                                                                                                                                              type DeleteableConsumer = {
                                                                                                                                                                                                                                  delete(): Promise<boolean>;
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                              delete +

                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                              • Returns Promise<boolean>

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/DeliverPolicy.html b/docs/jetstream/types/DeliverPolicy.html index 90d4c7eb..62948eef 100644 --- a/docs/jetstream/types/DeliverPolicy.html +++ b/docs/jetstream/types/DeliverPolicy.html @@ -1 +1 @@ -DeliverPolicy | @nats-io/jetstream
                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Type Alias DeliverPolicy

                                                                                                                                                                                                                                DeliverPolicy: typeof DeliverPolicy[keyof typeof DeliverPolicy]

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                +DeliverPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Type Alias DeliverPolicy

                                                                                                                                                                                                                                  DeliverPolicy: typeof DeliverPolicy[keyof typeof DeliverPolicy]

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/DeliveryInfo.html b/docs/jetstream/types/DeliveryInfo.html index 1a1961b4..fac075bc 100644 --- a/docs/jetstream/types/DeliveryInfo.html +++ b/docs/jetstream/types/DeliveryInfo.html @@ -1,4 +1,4 @@ -DeliveryInfo | @nats-io/jetstream
                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Type Alias DeliveryInfo

                                                                                                                                                                                                                                    type DeliveryInfo = {
                                                                                                                                                                                                                                        account_hash?: string;
                                                                                                                                                                                                                                        consumer: string;
                                                                                                                                                                                                                                        deliveryCount: number;
                                                                                                                                                                                                                                        deliverySequence: number;
                                                                                                                                                                                                                                        domain: string;
                                                                                                                                                                                                                                        pending: number;
                                                                                                                                                                                                                                        redelivered: boolean;
                                                                                                                                                                                                                                        stream: string;
                                                                                                                                                                                                                                        streamSequence: number;
                                                                                                                                                                                                                                        timestampNanos: number;
                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    account_hash? +DeliveryInfo | @nats-io/jetstream
                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Type Alias DeliveryInfo

                                                                                                                                                                                                                                      type DeliveryInfo = {
                                                                                                                                                                                                                                          account_hash?: string;
                                                                                                                                                                                                                                          consumer: string;
                                                                                                                                                                                                                                          deliveryCount: number;
                                                                                                                                                                                                                                          deliverySequence: number;
                                                                                                                                                                                                                                          domain: string;
                                                                                                                                                                                                                                          pending: number;
                                                                                                                                                                                                                                          redelivered: boolean;
                                                                                                                                                                                                                                          stream: string;
                                                                                                                                                                                                                                          streamSequence: number;
                                                                                                                                                                                                                                          timestampNanos: number;
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      account_hash? consumer deliveryCount deliverySequence @@ -9,14 +9,14 @@ streamSequence timestampNanos

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      account_hash?: string

                                                                                                                                                                                                                                      The hash of the sending account if applicable.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      consumer: string

                                                                                                                                                                                                                                      The intended consumer for the message.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      deliveryCount: number

                                                                                                                                                                                                                                      The number of times the message has been delivered.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      deliverySequence: number

                                                                                                                                                                                                                                      The client delivery sequence for the message

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      domain: string

                                                                                                                                                                                                                                      JetStream domain of the message if applicable.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      pending: number

                                                                                                                                                                                                                                      The number of pending messages for the consumer at the time the +

                                                                                                                                                                                                                                      consumer: string

                                                                                                                                                                                                                                      The intended consumer for the message.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      deliveryCount: number

                                                                                                                                                                                                                                      The number of times the message has been delivered.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      deliverySequence: number

                                                                                                                                                                                                                                      The client delivery sequence for the message

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      domain: string

                                                                                                                                                                                                                                      JetStream domain of the message if applicable.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      pending: number

                                                                                                                                                                                                                                      The number of pending messages for the consumer at the time the message was delivered.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      redelivered: boolean

                                                                                                                                                                                                                                      True if the message has been redelivered.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      stream: string

                                                                                                                                                                                                                                      The stream where the message came from

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      streamSequence: number

                                                                                                                                                                                                                                      The sequence number of the message in the stream

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      timestampNanos: number

                                                                                                                                                                                                                                      The timestamp for the message in nanoseconds. Convert with millis(n),

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      redelivered: boolean

                                                                                                                                                                                                                                      True if the message has been redelivered.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      stream: string

                                                                                                                                                                                                                                      The stream where the message came from

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      streamSequence: number

                                                                                                                                                                                                                                      The sequence number of the message in the stream

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      timestampNanos: number

                                                                                                                                                                                                                                      The timestamp for the message in nanoseconds. Convert with millis(n),

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/Destroyable.html b/docs/jetstream/types/Destroyable.html index ff39eac8..54d49cae 100644 --- a/docs/jetstream/types/Destroyable.html +++ b/docs/jetstream/types/Destroyable.html @@ -1,4 +1,4 @@ -Destroyable | @nats-io/jetstream
                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Type Alias Destroyable

                                                                                                                                                                                                                                        type Destroyable = {
                                                                                                                                                                                                                                            destroy(): Promise<void>;
                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                        destroy +Destroyable | @nats-io/jetstream
                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Type Alias Destroyable

                                                                                                                                                                                                                                          type Destroyable = {
                                                                                                                                                                                                                                              destroy(): Promise<void>;
                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                          destroy

                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                          • Destroys a resource on the server. Returns a promise that resolves to true whene the operation has been completed

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/DirectBatchLimits.html b/docs/jetstream/types/DirectBatchLimits.html index 2e7a8f77..343fa443 100644 --- a/docs/jetstream/types/DirectBatchLimits.html +++ b/docs/jetstream/types/DirectBatchLimits.html @@ -1,5 +1,5 @@ -DirectBatchLimits | @nats-io/jetstream
                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Type Alias DirectBatchLimits

                                                                                                                                                                                                                                            type DirectBatchLimits = {
                                                                                                                                                                                                                                                batch: number;
                                                                                                                                                                                                                                                callback: BatchCallback<StoredMsg>;
                                                                                                                                                                                                                                                max_bytes: number;
                                                                                                                                                                                                                                                next_by_subj?: string;
                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            batch +DirectBatchLimits | @nats-io/jetstream
                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Type Alias DirectBatchLimits

                                                                                                                                                                                                                                              type DirectBatchLimits = {
                                                                                                                                                                                                                                                  batch: number;
                                                                                                                                                                                                                                                  callback: BatchCallback<StoredMsg>;
                                                                                                                                                                                                                                                  max_bytes: number;
                                                                                                                                                                                                                                                  next_by_subj?: string;
                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              batch callback max_bytes next_by_subj? -

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              batch: number
                                                                                                                                                                                                                                              callback: BatchCallback<StoredMsg>
                                                                                                                                                                                                                                              max_bytes: number
                                                                                                                                                                                                                                              next_by_subj?: string

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              batch: number
                                                                                                                                                                                                                                              callback: BatchCallback<StoredMsg>
                                                                                                                                                                                                                                              max_bytes: number
                                                                                                                                                                                                                                              next_by_subj?: string

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/DirectBatchOptions.html b/docs/jetstream/types/DirectBatchOptions.html index adc13f32..90df48af 100644 --- a/docs/jetstream/types/DirectBatchOptions.html +++ b/docs/jetstream/types/DirectBatchOptions.html @@ -1 +1 @@ -DirectBatchOptions | @nats-io/jetstream
                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Type Alias DirectBatchOptions

                                                                                                                                                                                                                                                DirectBatchOptions: DirectBatchStartSeq | DirectBatchStartTime

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                +DirectBatchOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Type Alias DirectBatchOptions

                                                                                                                                                                                                                                                  DirectBatchOptions: DirectBatchStartSeq | DirectBatchStartTime

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/DirectBatchStartSeq.html b/docs/jetstream/types/DirectBatchStartSeq.html index e7c3b3c0..ec012363 100644 --- a/docs/jetstream/types/DirectBatchStartSeq.html +++ b/docs/jetstream/types/DirectBatchStartSeq.html @@ -1 +1 @@ -DirectBatchStartSeq | @nats-io/jetstream
                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Type Alias DirectBatchStartSeq

                                                                                                                                                                                                                                                    DirectBatchStartSeq: Partial<DirectBatchLimits> & {
                                                                                                                                                                                                                                                        seq: number;
                                                                                                                                                                                                                                                        start_time: never;
                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                    +DirectBatchStartSeq | @nats-io/jetstream
                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Type Alias DirectBatchStartSeq

                                                                                                                                                                                                                                                      DirectBatchStartSeq: Partial<DirectBatchLimits> & {
                                                                                                                                                                                                                                                          seq: number;
                                                                                                                                                                                                                                                          start_time?: never;
                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/DirectBatchStartTime.html b/docs/jetstream/types/DirectBatchStartTime.html index 6d4dd896..59971c63 100644 --- a/docs/jetstream/types/DirectBatchStartTime.html +++ b/docs/jetstream/types/DirectBatchStartTime.html @@ -1 +1 @@ -DirectBatchStartTime | @nats-io/jetstream
                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Type Alias DirectBatchStartTime

                                                                                                                                                                                                                                                        DirectBatchStartTime: Partial<DirectBatchLimits> & {
                                                                                                                                                                                                                                                            seq: never;
                                                                                                                                                                                                                                                            start_time: Date | string;
                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                        +DirectBatchStartTime | @nats-io/jetstream
                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Type Alias DirectBatchStartTime

                                                                                                                                                                                                                                                          DirectBatchStartTime: Partial<DirectBatchLimits> & {
                                                                                                                                                                                                                                                              seq?: never;
                                                                                                                                                                                                                                                              start_time: Date | string;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/DirectLastFor.html b/docs/jetstream/types/DirectLastFor.html index 4b858755..c410b23f 100644 --- a/docs/jetstream/types/DirectLastFor.html +++ b/docs/jetstream/types/DirectLastFor.html @@ -1 +1 @@ -DirectLastFor | @nats-io/jetstream
                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Type Alias DirectLastFor

                                                                                                                                                                                                                                                            DirectLastFor: {
                                                                                                                                                                                                                                                                multi_last: string[];
                                                                                                                                                                                                                                                                up_to_seq?: number;
                                                                                                                                                                                                                                                                up_to_time?: Date | string;
                                                                                                                                                                                                                                                            } & Partial<DirectBatchLimits>

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                            +DirectLastFor | @nats-io/jetstream
                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Type Alias DirectLastFor

                                                                                                                                                                                                                                                              DirectLastFor: {
                                                                                                                                                                                                                                                                  multi_last: string[];
                                                                                                                                                                                                                                                                  up_to_seq?: number;
                                                                                                                                                                                                                                                                  up_to_time?: Date | string;
                                                                                                                                                                                                                                                              } & Partial<DirectBatchLimits>

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/DirectMsgHeaders.html b/docs/jetstream/types/DirectMsgHeaders.html index d4ba9eb4..26c18ae5 100644 --- a/docs/jetstream/types/DirectMsgHeaders.html +++ b/docs/jetstream/types/DirectMsgHeaders.html @@ -1 +1 @@ -DirectMsgHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Type Alias DirectMsgHeaders

                                                                                                                                                                                                                                                                DirectMsgHeaders: typeof DirectMsgHeaders[keyof typeof DirectMsgHeaders]

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                +DirectMsgHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Type Alias DirectMsgHeaders

                                                                                                                                                                                                                                                                  DirectMsgHeaders: typeof DirectMsgHeaders[keyof typeof DirectMsgHeaders]

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/DirectMsgRequest.html b/docs/jetstream/types/DirectMsgRequest.html index 4725e889..dbd2f28a 100644 --- a/docs/jetstream/types/DirectMsgRequest.html +++ b/docs/jetstream/types/DirectMsgRequest.html @@ -1 +1 @@ -DirectMsgRequest | @nats-io/jetstream
                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Type Alias DirectMsgRequest

                                                                                                                                                                                                                                                                    DirectMsgRequest:
                                                                                                                                                                                                                                                                        | SeqMsgRequest
                                                                                                                                                                                                                                                                        | LastForMsgRequest
                                                                                                                                                                                                                                                                        | NextMsgRequest
                                                                                                                                                                                                                                                                        | StartTimeMsgRequest

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                    +DirectMsgRequest | @nats-io/jetstream
                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Type Alias DirectMsgRequest

                                                                                                                                                                                                                                                                      DirectMsgRequest:
                                                                                                                                                                                                                                                                          | SeqMsgRequest
                                                                                                                                                                                                                                                                          | LastForMsgRequest
                                                                                                                                                                                                                                                                          | NextMsgRequest
                                                                                                                                                                                                                                                                          | StartTimeMsgRequest

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/DirectStreamAPI.html b/docs/jetstream/types/DirectStreamAPI.html index 30a7b722..4e62db65 100644 --- a/docs/jetstream/types/DirectStreamAPI.html +++ b/docs/jetstream/types/DirectStreamAPI.html @@ -6,20 +6,20 @@ these APIs are subject to change.

                                                                                                                                                                                                                                                                      Note that these API can retrieve values from any replica, so it is possible for a lookup after an update to not include the message that was just added.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      type DirectStreamAPI = {
                                                                                                                                                                                                                                                                          getBatch(
                                                                                                                                                                                                                                                                              stream: string,
                                                                                                                                                                                                                                                                              opts: DirectBatchOptions,
                                                                                                                                                                                                                                                                          ): Promise<QueuedIterator<StoredMsg>>;
                                                                                                                                                                                                                                                                          getLastMessagesFor(
                                                                                                                                                                                                                                                                              stream: string,
                                                                                                                                                                                                                                                                              opts: DirectLastFor,
                                                                                                                                                                                                                                                                          ): Promise<QueuedIterator<StoredMsg>>;
                                                                                                                                                                                                                                                                          getMessage(stream: string, query: DirectMsgRequest): Promise<StoredMsg>;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                      getBatch +
                                                                                                                                                                                                                                                                      type DirectStreamAPI = {
                                                                                                                                                                                                                                                                          getBatch(
                                                                                                                                                                                                                                                                              stream: string,
                                                                                                                                                                                                                                                                              opts: DirectBatchOptions,
                                                                                                                                                                                                                                                                          ): Promise<QueuedIterator<StoredMsg>>;
                                                                                                                                                                                                                                                                          getLastMessagesFor(
                                                                                                                                                                                                                                                                              stream: string,
                                                                                                                                                                                                                                                                              opts: DirectLastFor,
                                                                                                                                                                                                                                                                          ): Promise<QueuedIterator<StoredMsg>>;
                                                                                                                                                                                                                                                                          getMessage(stream: string, query: DirectMsgRequest): Promise<StoredMsg>;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                      getBatch getLastMessagesFor getMessage

                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                      • Retrieves a batch of messages with an optional filter starting at a specific sequence or start time. Note that only a single subject filter is supported.

                                                                                                                                                                                                                                                                        This API is Non-Stable and subject to change.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        Returns Promise<QueuedIterator<StoredMsg>>

                                                                                                                                                                                                                                                                      • Retrieves the last message for each subject in the filter. +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        Returns Promise<QueuedIterator<StoredMsg>>

                                                                                                                                                                                                                                                                      • Retrieves the last message for each subject in the filter. If no filter is specified, a maximum of 1024 subjects are returned. Care should be given on the specified filters to ensure that the results match what the client is expecting and to avoid missing expected data.

                                                                                                                                                                                                                                                                        This API is Non-Stable and subject to change.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        Returns Promise<QueuedIterator<StoredMsg>>

                                                                                                                                                                                                                                                                      • Retrieves the message matching the specified query. Messages can be +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        Returns Promise<QueuedIterator<StoredMsg>>

                                                                                                                                                                                                                                                                      • Retrieves the message matching the specified query. Messages can be retrieved by sequence number or by last sequence matching a subject, or by looking for the next message sequence that matches a subject.

                                                                                                                                                                                                                                                                        This API is Non-Stable and subject to change.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        Returns Promise<StoredMsg>

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                      Returns Promise<StoredMsg>

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/Discard.html b/docs/jetstream/types/Discard.html index fcd14af6..5e8e86a4 100644 --- a/docs/jetstream/types/Discard.html +++ b/docs/jetstream/types/Discard.html @@ -1,7 +1,7 @@ Discard | @nats-io/jetstream
                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Type Alias Discard

                                                                                                                                                                                                                                                                        Requests for messages can be terminated by the server, these notifications provide information on the number of messages and/or bytes that couldn't be satisfied by the consumer request.

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        type Discard = {
                                                                                                                                                                                                                                                                            bytesLeft: number;
                                                                                                                                                                                                                                                                            messagesLeft: number;
                                                                                                                                                                                                                                                                            type: "discard";
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        bytesLeft +
                                                                                                                                                                                                                                                                        type Discard = {
                                                                                                                                                                                                                                                                            bytesLeft: number;
                                                                                                                                                                                                                                                                            messagesLeft: number;
                                                                                                                                                                                                                                                                            type: "discard";
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        bytesLeft messagesLeft type -

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        bytesLeft: number
                                                                                                                                                                                                                                                                        messagesLeft: number
                                                                                                                                                                                                                                                                        type: "discard"

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        bytesLeft: number
                                                                                                                                                                                                                                                                        messagesLeft: number
                                                                                                                                                                                                                                                                        type: "discard"

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/DiscardPolicy.html b/docs/jetstream/types/DiscardPolicy.html index c46650b2..84b90f9b 100644 --- a/docs/jetstream/types/DiscardPolicy.html +++ b/docs/jetstream/types/DiscardPolicy.html @@ -1 +1 @@ -DiscardPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Type Alias DiscardPolicy

                                                                                                                                                                                                                                                                          DiscardPolicy: typeof DiscardPolicy[keyof typeof DiscardPolicy]

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          +DiscardPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Type Alias DiscardPolicy

                                                                                                                                                                                                                                                                            DiscardPolicy: typeof DiscardPolicy[keyof typeof DiscardPolicy]

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                            diff --git a/docs/jetstream/types/ExceededLimits.html b/docs/jetstream/types/ExceededLimits.html index 970c775e..8ee7e6dc 100644 --- a/docs/jetstream/types/ExceededLimits.html +++ b/docs/jetstream/types/ExceededLimits.html @@ -1,7 +1,7 @@ ExceededLimits | @nats-io/jetstream
                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Type Alias ExceededLimits

                                                                                                                                                                                                                                                                              This notification is specific to pull consumers and will be notified whenever the pull request exceeds some limit such as maxwaiting, maxrequestbatch, etc. The data component has the code (409) and the message from the server.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              type ExceededLimits = {
                                                                                                                                                                                                                                                                                  code: number;
                                                                                                                                                                                                                                                                                  description: string;
                                                                                                                                                                                                                                                                                  type: "exceeded_limits";
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              code +
                                                                                                                                                                                                                                                                              type ExceededLimits = {
                                                                                                                                                                                                                                                                                  code: number;
                                                                                                                                                                                                                                                                                  description: string;
                                                                                                                                                                                                                                                                                  type: "exceeded_limits";
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              code description type -

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              code: number
                                                                                                                                                                                                                                                                              description: string
                                                                                                                                                                                                                                                                              type: "exceeded_limits"

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              code: number
                                                                                                                                                                                                                                                                              description: string
                                                                                                                                                                                                                                                                              type: "exceeded_limits"

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/Expires.html b/docs/jetstream/types/Expires.html index be0d7576..b3828e50 100644 --- a/docs/jetstream/types/Expires.html +++ b/docs/jetstream/types/Expires.html @@ -1,9 +1,9 @@ -Expires | @nats-io/jetstream
                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Type Alias Expires

                                                                                                                                                                                                                                                                                type Expires = {
                                                                                                                                                                                                                                                                                    expires?: number;
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                expires? -

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                expires?: number

                                                                                                                                                                                                                                                                                Amount of milliseconds to wait for messages before issuing another request. +Expires | @nats-io/jetstream

                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Type Alias Expires

                                                                                                                                                                                                                                                                                  type Expires = {
                                                                                                                                                                                                                                                                                      expires?: number;
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  expires? +

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  expires?: number

                                                                                                                                                                                                                                                                                  Number of milliseconds to wait for messages before issuing another request. Note this value shouldn't be set by the user, as the default provides proper behavior. A low value will stress the server.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Minimum value is 1000 (1s).

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  The minimum value is 1000 (1s).

                                                                                                                                                                                                                                                                                  30_000 (30s)
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/ExportedConsumer.html b/docs/jetstream/types/ExportedConsumer.html index 09fb9910..853c3230 100644 --- a/docs/jetstream/types/ExportedConsumer.html +++ b/docs/jetstream/types/ExportedConsumer.html @@ -1 +1 @@ -ExportedConsumer | @nats-io/jetstream
                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Type Alias ExportedConsumer

                                                                                                                                                                                                                                                                                    ExportedConsumer: ConsumerKind & {
                                                                                                                                                                                                                                                                                        consume(opts?: ConsumeOptions): Promise<ConsumerMessages>;
                                                                                                                                                                                                                                                                                        fetch(opts?: FetchOptions): Promise<ConsumerMessages>;
                                                                                                                                                                                                                                                                                        next(opts?: NextOptions): Promise<JsMsg>;
                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                    +ExportedConsumer | @nats-io/jetstream
                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Type Alias ExportedConsumer

                                                                                                                                                                                                                                                                                      ExportedConsumer: ConsumerKind & {
                                                                                                                                                                                                                                                                                          consume(opts?: ConsumeOptions): Promise<ConsumerMessages>;
                                                                                                                                                                                                                                                                                          fetch(opts?: FetchOptions): Promise<ConsumerMessages>;
                                                                                                                                                                                                                                                                                          next(opts?: NextOptions): Promise<JsMsg>;
                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/ExternalStream.html b/docs/jetstream/types/ExternalStream.html index dd983030..71488462 100644 --- a/docs/jetstream/types/ExternalStream.html +++ b/docs/jetstream/types/ExternalStream.html @@ -1,6 +1,6 @@ -ExternalStream | @nats-io/jetstream
                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Type Alias ExternalStream

                                                                                                                                                                                                                                                                                        type ExternalStream = {
                                                                                                                                                                                                                                                                                            api: string;
                                                                                                                                                                                                                                                                                            deliver?: string;
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        api +ExternalStream | @nats-io/jetstream
                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Type Alias ExternalStream

                                                                                                                                                                                                                                                                                          type ExternalStream = {
                                                                                                                                                                                                                                                                                              api: string;
                                                                                                                                                                                                                                                                                              deliver?: string;
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          api deliver?

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          api: string

                                                                                                                                                                                                                                                                                          API prefix for the remote stream - the API prefix should be something like `$JS.domain.API where domain is the JetStream domain on the NATS server configuration.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          deliver?: string

                                                                                                                                                                                                                                                                                          Deliver prefix for the remote stream

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          deliver?: string

                                                                                                                                                                                                                                                                                          Deliver prefix for the remote stream

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/FetchBytes.html b/docs/jetstream/types/FetchBytes.html index 7687fe54..7ff3a920 100644 --- a/docs/jetstream/types/FetchBytes.html +++ b/docs/jetstream/types/FetchBytes.html @@ -1,2 +1,2 @@ -FetchBytes | @nats-io/jetstream
                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Type Alias FetchBytes

                                                                                                                                                                                                                                                                                            FetchBytes: MaxBytes & Partial<MaxMessages> & Expires & IdleHeartbeat & Bind & Partial<
                                                                                                                                                                                                                                                                                                OverflowOptions,
                                                                                                                                                                                                                                                                                            >

                                                                                                                                                                                                                                                                                            Options for fetching bytes

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                            +FetchBytes | @nats-io/jetstream
                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Type Alias FetchBytes

                                                                                                                                                                                                                                                                                              FetchBytes: MaxBytes & Partial<MaxMessages> & Expires & IdleHeartbeat & Bind & Partial<
                                                                                                                                                                                                                                                                                                  OverflowOptions,
                                                                                                                                                                                                                                                                                              > & Partial<PrioritizedOptions>

                                                                                                                                                                                                                                                                                              Options for fetching bytes

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/FetchMessages.html b/docs/jetstream/types/FetchMessages.html index f509b150..e23a0adf 100644 --- a/docs/jetstream/types/FetchMessages.html +++ b/docs/jetstream/types/FetchMessages.html @@ -1,2 +1,2 @@ -FetchMessages | @nats-io/jetstream
                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Type Alias FetchMessages

                                                                                                                                                                                                                                                                                                FetchMessages: Partial<MaxMessages> & Expires & IdleHeartbeat & Bind & Partial<
                                                                                                                                                                                                                                                                                                    OverflowOptions,
                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                Options for fetching messages

                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                +FetchMessages | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Type Alias FetchMessages

                                                                                                                                                                                                                                                                                                  FetchMessages: Partial<MaxMessages> & Expires & IdleHeartbeat & Bind & Partial<
                                                                                                                                                                                                                                                                                                      OverflowOptions,
                                                                                                                                                                                                                                                                                                  > & Partial<PrioritizedOptions>

                                                                                                                                                                                                                                                                                                  Options for fetching messages

                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/FetchOptions.html b/docs/jetstream/types/FetchOptions.html index e5ff57f0..56e6f280 100644 --- a/docs/jetstream/types/FetchOptions.html +++ b/docs/jetstream/types/FetchOptions.html @@ -1 +1 @@ -FetchOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Type Alias FetchOptions

                                                                                                                                                                                                                                                                                                    FetchOptions: FetchBytes | FetchMessages

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                    +FetchOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Type Alias FetchOptions

                                                                                                                                                                                                                                                                                                      FetchOptions: FetchBytes | FetchMessages

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/FlowControl.html b/docs/jetstream/types/FlowControl.html index 9c465607..c9566cc1 100644 --- a/docs/jetstream/types/FlowControl.html +++ b/docs/jetstream/types/FlowControl.html @@ -1,4 +1,4 @@ FlowControl | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Type Alias FlowControl

                                                                                                                                                                                                                                                                                                        Notifies that the client received a server-side flow control message. The data is null.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        type FlowControl = {
                                                                                                                                                                                                                                                                                                            type: "flow_control";
                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        type -

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        type: "flow_control"

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        type FlowControl = {
                                                                                                                                                                                                                                                                                                            type: "flow_control";
                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        type +

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        type: "flow_control"

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/Heartbeat.html b/docs/jetstream/types/Heartbeat.html index 6e0ae8ca..12c03a66 100644 --- a/docs/jetstream/types/Heartbeat.html +++ b/docs/jetstream/types/Heartbeat.html @@ -1,6 +1,6 @@ Heartbeat | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Type Alias Heartbeat

                                                                                                                                                                                                                                                                                                          Notifies that the client received a server-side heartbeat. The payload the data portion has the format {natsLastConsumer: number, natsLastStream: number};

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          type Heartbeat = {
                                                                                                                                                                                                                                                                                                              lastConsumerSequence: number;
                                                                                                                                                                                                                                                                                                              lastStreamSequence: number;
                                                                                                                                                                                                                                                                                                              type: "heartbeat";
                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          lastConsumerSequence +
                                                                                                                                                                                                                                                                                                          type Heartbeat = {
                                                                                                                                                                                                                                                                                                              lastConsumerSequence: number;
                                                                                                                                                                                                                                                                                                              lastStreamSequence: number;
                                                                                                                                                                                                                                                                                                              type: "heartbeat";
                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          lastConsumerSequence lastStreamSequence type -

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          lastConsumerSequence: number
                                                                                                                                                                                                                                                                                                          lastStreamSequence: number
                                                                                                                                                                                                                                                                                                          type: "heartbeat"

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          lastConsumerSequence: number
                                                                                                                                                                                                                                                                                                          lastStreamSequence: number
                                                                                                                                                                                                                                                                                                          type: "heartbeat"

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/HeartbeatsMissed.html b/docs/jetstream/types/HeartbeatsMissed.html index 177d04d5..64f920e1 100644 --- a/docs/jetstream/types/HeartbeatsMissed.html +++ b/docs/jetstream/types/HeartbeatsMissed.html @@ -2,6 +2,6 @@ The data portion of the status, is a number indicating the number of missed heartbeats. Note that when a client disconnects, heartbeat tracking is paused while the client is disconnected.

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          type HeartbeatsMissed = {
                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                              type: "heartbeats_missed";
                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          count +
                                                                                                                                                                                                                                                                                                          type HeartbeatsMissed = {
                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                              type: "heartbeats_missed";
                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          count type -

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          count: number
                                                                                                                                                                                                                                                                                                          type: "heartbeats_missed"

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          count: number
                                                                                                                                                                                                                                                                                                          type: "heartbeats_missed"

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/IdleHeartbeat.html b/docs/jetstream/types/IdleHeartbeat.html index 4d38221d..01e53aa6 100644 --- a/docs/jetstream/types/IdleHeartbeat.html +++ b/docs/jetstream/types/IdleHeartbeat.html @@ -1,6 +1,6 @@ -IdleHeartbeat | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Type Alias IdleHeartbeat

                                                                                                                                                                                                                                                                                                            type IdleHeartbeat = {
                                                                                                                                                                                                                                                                                                                idle_heartbeat?: number;
                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            idle_heartbeat? +IdleHeartbeat | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Type Alias IdleHeartbeat

                                                                                                                                                                                                                                                                                                              type IdleHeartbeat = {
                                                                                                                                                                                                                                                                                                                  idle_heartbeat?: number;
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              idle_heartbeat?

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              idle_heartbeat?: number

                                                                                                                                                                                                                                                                                                              Number of milliseconds to wait for a server heartbeat when not actively receiving messages. When two or more heartbeats are missed in a row, the consumer will emit a notification. Note this value shouldn't be set by the user, as the default provides the proper behavior. A low value will stress the server.

                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/InfoableConsumer.html b/docs/jetstream/types/InfoableConsumer.html index 79bd6667..c4966221 100644 --- a/docs/jetstream/types/InfoableConsumer.html +++ b/docs/jetstream/types/InfoableConsumer.html @@ -1,2 +1,2 @@ -InfoableConsumer | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Type Alias InfoableConsumer

                                                                                                                                                                                                                                                                                                                type InfoableConsumer = {
                                                                                                                                                                                                                                                                                                                    info(cached?: boolean): Promise<ConsumerInfo>;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                info -

                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                  • Optionalcached: boolean

                                                                                                                                                                                                                                                                                                                  Returns Promise<ConsumerInfo>

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                +InfoableConsumer | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Type Alias InfoableConsumer

                                                                                                                                                                                                                                                                                                                  type InfoableConsumer = {
                                                                                                                                                                                                                                                                                                                      info(cached?: boolean): Promise<ConsumerInfo>;
                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                  info +

                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • Optionalcached: boolean

                                                                                                                                                                                                                                                                                                                    Returns Promise<ConsumerInfo>

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/JetStreamAccountStats.html b/docs/jetstream/types/JetStreamAccountStats.html index 4f3895ac..a000eb80 100644 --- a/docs/jetstream/types/JetStreamAccountStats.html +++ b/docs/jetstream/types/JetStreamAccountStats.html @@ -1 +1 @@ -JetStreamAccountStats | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Type Alias JetStreamAccountStats

                                                                                                                                                                                                                                                                                                                    JetStreamAccountStats: JetStreamUsageAccountLimits & {
                                                                                                                                                                                                                                                                                                                        api: JetStreamApiStats;
                                                                                                                                                                                                                                                                                                                        domain?: string;
                                                                                                                                                                                                                                                                                                                        tiers?: {
                                                                                                                                                                                                                                                                                                                            R1?: JetStreamUsageAccountLimits;
                                                                                                                                                                                                                                                                                                                            R3?: JetStreamUsageAccountLimits;
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                    +JetStreamAccountStats | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Type Alias JetStreamAccountStats

                                                                                                                                                                                                                                                                                                                      JetStreamAccountStats: JetStreamUsageAccountLimits & {
                                                                                                                                                                                                                                                                                                                          api: JetStreamApiStats;
                                                                                                                                                                                                                                                                                                                          domain?: string;
                                                                                                                                                                                                                                                                                                                          tiers?: {
                                                                                                                                                                                                                                                                                                                              R1?: JetStreamUsageAccountLimits;
                                                                                                                                                                                                                                                                                                                              R3?: JetStreamUsageAccountLimits;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/JetStreamApiCodes.html b/docs/jetstream/types/JetStreamApiCodes.html index bccd90b5..bdc6a85a 100644 --- a/docs/jetstream/types/JetStreamApiCodes.html +++ b/docs/jetstream/types/JetStreamApiCodes.html @@ -1 +1 @@ -JetStreamApiCodes | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Type Alias JetStreamApiCodes

                                                                                                                                                                                                                                                                                                                        JetStreamApiCodes: typeof JetStreamApiCodes[keyof typeof JetStreamApiCodes]

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                        +JetStreamApiCodes | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Type Alias JetStreamApiCodes

                                                                                                                                                                                                                                                                                                                          JetStreamApiCodes: typeof JetStreamApiCodes[keyof typeof JetStreamApiCodes]

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/JetStreamApiStats.html b/docs/jetstream/types/JetStreamApiStats.html index ee6a8cd6..10ab4916 100644 --- a/docs/jetstream/types/JetStreamApiStats.html +++ b/docs/jetstream/types/JetStreamApiStats.html @@ -1,5 +1,5 @@ -JetStreamApiStats | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Type Alias JetStreamApiStats

                                                                                                                                                                                                                                                                                                                            type JetStreamApiStats = {
                                                                                                                                                                                                                                                                                                                                errors: number;
                                                                                                                                                                                                                                                                                                                                total: number;
                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            errors +JetStreamApiStats | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Type Alias JetStreamApiStats

                                                                                                                                                                                                                                                                                                                              type JetStreamApiStats = {
                                                                                                                                                                                                                                                                                                                                  errors: number;
                                                                                                                                                                                                                                                                                                                                  total: number;
                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              errors total

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              errors: number

                                                                                                                                                                                                                                                                                                                              "API requests that resulted in an error response"

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              total: number

                                                                                                                                                                                                                                                                                                                              Total number of API requests received for this account

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              total: number

                                                                                                                                                                                                                                                                                                                              Total number of API requests received for this account

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/JetStreamClient.html b/docs/jetstream/types/JetStreamClient.html index d4d33e1e..2df5e974 100644 --- a/docs/jetstream/types/JetStreamClient.html +++ b/docs/jetstream/types/JetStreamClient.html @@ -1,20 +1,24 @@ JetStreamClient | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Type Alias JetStreamClient

                                                                                                                                                                                                                                                                                                                                A type for interacting data stored in JetStream

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                type JetStreamClient = {
                                                                                                                                                                                                                                                                                                                                    apiPrefix: string;
                                                                                                                                                                                                                                                                                                                                    consumers: Consumers;
                                                                                                                                                                                                                                                                                                                                    streams: Streams;
                                                                                                                                                                                                                                                                                                                                    getOptions(): JetStreamOptions;
                                                                                                                                                                                                                                                                                                                                    jetstreamManager(checkAPI?: boolean): Promise<JetStreamManager>;
                                                                                                                                                                                                                                                                                                                                    publish(
                                                                                                                                                                                                                                                                                                                                        subj: string,
                                                                                                                                                                                                                                                                                                                                        payload?: Payload,
                                                                                                                                                                                                                                                                                                                                        options?: Partial<JetStreamPublishOptions>,
                                                                                                                                                                                                                                                                                                                                    ): Promise<PubAck>;
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                apiPrefix +
                                                                                                                                                                                                                                                                                                                                type JetStreamClient = {
                                                                                                                                                                                                                                                                                                                                    apiPrefix: string;
                                                                                                                                                                                                                                                                                                                                    consumers: Consumers;
                                                                                                                                                                                                                                                                                                                                    streams: Streams;
                                                                                                                                                                                                                                                                                                                                    getOptions(): JetStreamOptions;
                                                                                                                                                                                                                                                                                                                                    jetstreamManager(checkAPI?: boolean): Promise<JetStreamManager>;
                                                                                                                                                                                                                                                                                                                                    publish(
                                                                                                                                                                                                                                                                                                                                        subj: string,
                                                                                                                                                                                                                                                                                                                                        payload?: Payload,
                                                                                                                                                                                                                                                                                                                                        options?: Partial<JetStreamPublishOptions>,
                                                                                                                                                                                                                                                                                                                                    ): Promise<PubAck>;
                                                                                                                                                                                                                                                                                                                                    startBatch(
                                                                                                                                                                                                                                                                                                                                        subj: string,
                                                                                                                                                                                                                                                                                                                                        payload?: Payload,
                                                                                                                                                                                                                                                                                                                                        opts?: Partial<JetStreamPublishOptions>,
                                                                                                                                                                                                                                                                                                                                    ): Promise<Batch>;
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                apiPrefix consumers streams

                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                getOptions jetstreamManager publish +startBatch

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                apiPrefix: string

                                                                                                                                                                                                                                                                                                                                Returns the JS API prefix as processed from the JetStream Options

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                consumers: Consumers

                                                                                                                                                                                                                                                                                                                                Returns an object for accessing Consumers. Consumers +

                                                                                                                                                                                                                                                                                                                                consumers: Consumers

                                                                                                                                                                                                                                                                                                                                Returns an object for accessing Consumers. Consumers allow you to process messages stored in a stream. To create a consumer use JetStreamManager.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                streams: Streams

                                                                                                                                                                                                                                                                                                                                Returns an object for accessing Streams.

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                • Returns a JetStreamManager that uses the same JetStreamOptions +

                                                                                                                                                                                                                                                                                                                                streams: Streams

                                                                                                                                                                                                                                                                                                                                Returns an object for accessing Streams.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                • Returns a JetStreamManager that uses the same JetStreamOptions as the current JetStream context

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                  • OptionalcheckAPI: boolean

                                                                                                                                                                                                                                                                                                                                  Returns Promise<JetStreamManager>

                                                                                                                                                                                                                                                                                                                                • Publishes a message to a stream. If not stream is configured to store the message, the +

                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                  • OptionalcheckAPI: boolean

                                                                                                                                                                                                                                                                                                                                  Returns Promise<JetStreamManager>

                                                                                                                                                                                                                                                                                                                                • Publishes a message to a stream. If not stream is configured to store the message, the request will fail with RequestError error with a nested NoRespondersError.

                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                  • subj: string

                                                                                                                                                                                                                                                                                                                                    the subject for the message

                                                                                                                                                                                                                                                                                                                                  • Optionalpayload: Payload

                                                                                                                                                                                                                                                                                                                                    the message's data

                                                                                                                                                                                                                                                                                                                                  • Optionaloptions: Partial<JetStreamPublishOptions>

                                                                                                                                                                                                                                                                                                                                    the optional message

                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                  Returns Promise<PubAck>

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Returns Promise<PubAck>

                                                                                                                                                                                                                                                                                                                                • Starts a batch publish operation on a stream by publishing this first message. +Additional messages are added to the batch using the returned Batch API and +committing the batch.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                  Returns Promise<Batch>

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                diff --git a/docs/jetstream/types/JetStreamManager.html b/docs/jetstream/types/JetStreamManager.html index 34a5f7bd..be9eae11 100644 --- a/docs/jetstream/types/JetStreamManager.html +++ b/docs/jetstream/types/JetStreamManager.html @@ -1,5 +1,5 @@ JetStreamManager | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Type Alias JetStreamManager

                                                                                                                                                                                                                                                                                                                                  The API for interacting with JetStream resources

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  type JetStreamManager = {
                                                                                                                                                                                                                                                                                                                                      consumers: ConsumerAPI;
                                                                                                                                                                                                                                                                                                                                      direct: DirectStreamAPI;
                                                                                                                                                                                                                                                                                                                                      streams: StreamAPI;
                                                                                                                                                                                                                                                                                                                                      advisories(): AsyncIterable<Advisory>;
                                                                                                                                                                                                                                                                                                                                      getAccountInfo(): Promise<JetStreamAccountStats>;
                                                                                                                                                                                                                                                                                                                                      getOptions(): JetStreamOptions;
                                                                                                                                                                                                                                                                                                                                      jetstream(): JetStreamClient;
                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  consumers +
                                                                                                                                                                                                                                                                                                                                  type JetStreamManager = {
                                                                                                                                                                                                                                                                                                                                      consumers: ConsumerAPI;
                                                                                                                                                                                                                                                                                                                                      direct: DirectStreamAPI;
                                                                                                                                                                                                                                                                                                                                      streams: StreamAPI;
                                                                                                                                                                                                                                                                                                                                      advisories(): AsyncIterable<Advisory>;
                                                                                                                                                                                                                                                                                                                                      getAccountInfo(): Promise<JetStreamAccountStats>;
                                                                                                                                                                                                                                                                                                                                      getOptions(): JetStreamOptions;
                                                                                                                                                                                                                                                                                                                                      jetstream(): JetStreamClient;
                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  consumers direct streams

                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                  advisories @@ -7,16 +7,16 @@ getOptions jetstream

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  consumers: ConsumerAPI

                                                                                                                                                                                                                                                                                                                                  JetStream API to interact with Consumers

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  direct: DirectStreamAPI

                                                                                                                                                                                                                                                                                                                                  API for accessing messages in a stream without using a Consumer. +

                                                                                                                                                                                                                                                                                                                                  direct: DirectStreamAPI

                                                                                                                                                                                                                                                                                                                                  API for accessing messages in a stream without using a Consumer. This API can retrieve values from any of the stream replicas, which means that it may not reflect inflight changes to the stream. Direct APIs require the stream to have the direct option enabled.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  streams: StreamAPI

                                                                                                                                                                                                                                                                                                                                  JetStream API to interact with Streams

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                  • Returns an async iteartor

                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                    Returns AsyncIterable<Advisory>

                                                                                                                                                                                                                                                                                                                                  streams: StreamAPI

                                                                                                                                                                                                                                                                                                                                  JetStream API to interact with Streams

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                  • Returns an async iteartor

                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Returns AsyncIterable<Advisory>

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Returns JetStreamClient

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/JetStreamManagerOptions.html b/docs/jetstream/types/JetStreamManagerOptions.html index 03752738..f6cf0c29 100644 --- a/docs/jetstream/types/JetStreamManagerOptions.html +++ b/docs/jetstream/types/JetStreamManagerOptions.html @@ -1,3 +1,3 @@ JetStreamManagerOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Type Alias JetStreamManagerOptions

                                                                                                                                                                                                                                                                                                                                    JetStreamManagerOptions: JetStreamOptions & { checkAPI?: boolean }

                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                    • OptionalcheckAPI?: boolean

                                                                                                                                                                                                                                                                                                                                      Allows disabling a check on the account for JetStream enablement see ().

                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/jetstream/types/JetStreamOptions.html b/docs/jetstream/types/JetStreamOptions.html index 31d6477d..9021ed9b 100644 --- a/docs/jetstream/types/JetStreamOptions.html +++ b/docs/jetstream/types/JetStreamOptions.html @@ -1,13 +1,13 @@ -JetStreamOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Type Alias JetStreamOptions

                                                                                                                                                                                                                                                                                                                                      type JetStreamOptions = {
                                                                                                                                                                                                                                                                                                                                          apiPrefix?: string;
                                                                                                                                                                                                                                                                                                                                          domain?: string;
                                                                                                                                                                                                                                                                                                                                          timeout?: number;
                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      apiPrefix? +JetStreamOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Type Alias JetStreamOptions

                                                                                                                                                                                                                                                                                                                                        type JetStreamOptions = {
                                                                                                                                                                                                                                                                                                                                            apiPrefix?: string;
                                                                                                                                                                                                                                                                                                                                            domain?: string;
                                                                                                                                                                                                                                                                                                                                            timeout?: number;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        apiPrefix? domain? timeout?

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        apiPrefix?: string

                                                                                                                                                                                                                                                                                                                                        Prefix required to interact with JetStream. Must match server configuration.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        domain?: string

                                                                                                                                                                                                                                                                                                                                        Name of the JetStream domain. This value automatically modifies +

                                                                                                                                                                                                                                                                                                                                        domain?: string

                                                                                                                                                                                                                                                                                                                                        Name of the JetStream domain. This value automatically modifies the default JetStream apiPrefix.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        timeout?: number

                                                                                                                                                                                                                                                                                                                                        Number of milliseconds to wait for a JetStream API request.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        timeout?: number

                                                                                                                                                                                                                                                                                                                                        Number of milliseconds to wait for a JetStream API request.

                                                                                                                                                                                                                                                                                                                                        ConnectionOptions.timeout

                                                                                                                                                                                                                                                                                                                                        ConnectionOptions.timeout

                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/JetStreamPublishOptions.html b/docs/jetstream/types/JetStreamPublishOptions.html index d4de71a0..16041857 100644 --- a/docs/jetstream/types/JetStreamPublishOptions.html +++ b/docs/jetstream/types/JetStreamPublishOptions.html @@ -1,20 +1,26 @@ JetStreamPublishOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Type Alias JetStreamPublishOptions

                                                                                                                                                                                                                                                                                                                                          Options for messages published to JetStream

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          type JetStreamPublishOptions = {
                                                                                                                                                                                                                                                                                                                                              expect: Partial<
                                                                                                                                                                                                                                                                                                                                                  {
                                                                                                                                                                                                                                                                                                                                                      lastMsgID: string;
                                                                                                                                                                                                                                                                                                                                                      lastSequence: number;
                                                                                                                                                                                                                                                                                                                                                      lastSubjectSequence: number;
                                                                                                                                                                                                                                                                                                                                                      streamName: string;
                                                                                                                                                                                                                                                                                                                                                  },
                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                              headers: MsgHdrs;
                                                                                                                                                                                                                                                                                                                                              msgID: string;
                                                                                                                                                                                                                                                                                                                                              retries?: number;
                                                                                                                                                                                                                                                                                                                                              timeout: number;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          expect +
                                                                                                                                                                                                                                                                                                                                          type JetStreamPublishOptions = {
                                                                                                                                                                                                                                                                                                                                              expect: Partial<StreamExpectations>;
                                                                                                                                                                                                                                                                                                                                              headers: MsgHdrs;
                                                                                                                                                                                                                                                                                                                                              msgID: string;
                                                                                                                                                                                                                                                                                                                                              retries?: number;
                                                                                                                                                                                                                                                                                                                                              schedule?: ScheduleOptions;
                                                                                                                                                                                                                                                                                                                                              timeout: number;
                                                                                                                                                                                                                                                                                                                                              ttl?: string;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          expect headers msgID retries? +schedule? timeout -

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          expect: Partial<
                                                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                                                  lastMsgID: string;
                                                                                                                                                                                                                                                                                                                                                  lastSequence: number;
                                                                                                                                                                                                                                                                                                                                                  lastSubjectSequence: number;
                                                                                                                                                                                                                                                                                                                                                  streamName: string;
                                                                                                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                                                                                                          >

                                                                                                                                                                                                                                                                                                                                          Set of constraints that when specified are verified by the server. +ttl? +

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          expect: Partial<StreamExpectations>

                                                                                                                                                                                                                                                                                                                                          Set of constraints that when specified are verified by the server. If the constraint(s) doesn't match, the server will reject the message. These settings allow you to implement deduplication and consistency strategies.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          headers: MsgHdrs

                                                                                                                                                                                                                                                                                                                                          Headers associated with the message. You can create an instance of +

                                                                                                                                                                                                                                                                                                                                          headers: MsgHdrs

                                                                                                                                                                                                                                                                                                                                          Headers associated with the message. You can create an instance of MsgHdrs with the headers() function.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          msgID: string

                                                                                                                                                                                                                                                                                                                                          A string identifier used to detect duplicate published messages. +

                                                                                                                                                                                                                                                                                                                                          msgID: string

                                                                                                                                                                                                                                                                                                                                          A string identifier used to detect duplicate published messages. If the msgID is reused within the stream's duplicate_window, the message will be rejected by the stream, and the PubAck will mark it as a duplicate.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          retries?: number

                                                                                                                                                                                                                                                                                                                                          Continue to attempt to publish if the publish fails due to a no responders error. +

                                                                                                                                                                                                                                                                                                                                          retries?: number

                                                                                                                                                                                                                                                                                                                                          Continue to attempt to publish if the publish fails due to a no responders error. Default is 1.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          timeout: number

                                                                                                                                                                                                                                                                                                                                          The number of milliseconds to wait for the PubAck

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          schedule?: ScheduleOptions

                                                                                                                                                                                                                                                                                                                                          Specifies the schedule for the message.

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          timeout: number

                                                                                                                                                                                                                                                                                                                                          The number of milliseconds to wait for the PubAck

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          ttl?: string

                                                                                                                                                                                                                                                                                                                                          Sets PubHeaders.MessageTTL this only applies to streams that enable +StreamConfig.allow_msg_ttl. The format of this value is "1s" or "1h", +etc, or a plain number interpreted as the number of seconds.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/JetStreamUsage.html b/docs/jetstream/types/JetStreamUsage.html index 689a0841..e8a64abf 100644 --- a/docs/jetstream/types/JetStreamUsage.html +++ b/docs/jetstream/types/JetStreamUsage.html @@ -1,9 +1,9 @@ -JetStreamUsage | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Type Alias JetStreamUsage

                                                                                                                                                                                                                                                                                                                                            type JetStreamUsage = {
                                                                                                                                                                                                                                                                                                                                                consumers: number;
                                                                                                                                                                                                                                                                                                                                                memory: number;
                                                                                                                                                                                                                                                                                                                                                storage: number;
                                                                                                                                                                                                                                                                                                                                                streams: number;
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            consumers +JetStreamUsage | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Type Alias JetStreamUsage

                                                                                                                                                                                                                                                                                                                                              type JetStreamUsage = {
                                                                                                                                                                                                                                                                                                                                                  consumers: number;
                                                                                                                                                                                                                                                                                                                                                  memory: number;
                                                                                                                                                                                                                                                                                                                                                  storage: number;
                                                                                                                                                                                                                                                                                                                                                  streams: number;
                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              consumers memory storage streams

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              consumers: number

                                                                                                                                                                                                                                                                                                                                              "Number of active Consumers

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              memory: number

                                                                                                                                                                                                                                                                                                                                              Memory Storage being used for Stream Message storage

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              storage: number

                                                                                                                                                                                                                                                                                                                                              File Storage being used for Stream Message storage

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              streams: number

                                                                                                                                                                                                                                                                                                                                              Number of active Streams

                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              memory: number

                                                                                                                                                                                                                                                                                                                                              Memory Storage being used for Stream Message storage

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              storage: number

                                                                                                                                                                                                                                                                                                                                              File Storage being used for Stream Message storage

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              streams: number

                                                                                                                                                                                                                                                                                                                                              Number of active Streams

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/JetStreamUsageAccountLimits.html b/docs/jetstream/types/JetStreamUsageAccountLimits.html index b7c239b1..e1eae86f 100644 --- a/docs/jetstream/types/JetStreamUsageAccountLimits.html +++ b/docs/jetstream/types/JetStreamUsageAccountLimits.html @@ -1 +1 @@ -JetStreamUsageAccountLimits | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Type Alias JetStreamUsageAccountLimits

                                                                                                                                                                                                                                                                                                                                                JetStreamUsageAccountLimits: JetStreamUsage & { limits: AccountLimits }

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                +JetStreamUsageAccountLimits | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Type Alias JetStreamUsageAccountLimits

                                                                                                                                                                                                                                                                                                                                                  JetStreamUsageAccountLimits: JetStreamUsage & { limits: AccountLimits }

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/JsHeaders.html b/docs/jetstream/types/JsHeaders.html index 4d41d71c..375bc338 100644 --- a/docs/jetstream/types/JsHeaders.html +++ b/docs/jetstream/types/JsHeaders.html @@ -1 +1 @@ -JsHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Type Alias JsHeaders

                                                                                                                                                                                                                                                                                                                                                    JsHeaders: typeof JsHeaders[keyof typeof JsHeaders]

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    +JsHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Type Alias JsHeaders

                                                                                                                                                                                                                                                                                                                                                      JsHeaders: typeof JsHeaders[keyof typeof JsHeaders]

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/LastForMsgRequest.html b/docs/jetstream/types/LastForMsgRequest.html index b794d014..f22e3d95 100644 --- a/docs/jetstream/types/LastForMsgRequest.html +++ b/docs/jetstream/types/LastForMsgRequest.html @@ -1,3 +1,3 @@ LastForMsgRequest | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Type Alias LastForMsgRequest

                                                                                                                                                                                                                                                                                                                                                        Retrieves the last message with the given subject

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        type LastForMsgRequest = {
                                                                                                                                                                                                                                                                                                                                                            last_by_subj: string;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        last_by_subj -

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        last_by_subj: string

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        type LastForMsgRequest = {
                                                                                                                                                                                                                                                                                                                                                            last_by_subj: string;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        last_by_subj +

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        last_by_subj: string

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/Lister.html b/docs/jetstream/types/Lister.html index c9ff7601..411603c4 100644 --- a/docs/jetstream/types/Lister.html +++ b/docs/jetstream/types/Lister.html @@ -1,4 +1,4 @@ -Lister | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Type Alias Lister<T>

                                                                                                                                                                                                                                                                                                                                                          An type for listing. Returns a promise with typed list.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          type Lister<T> = {
                                                                                                                                                                                                                                                                                                                                                              "[asyncIterator]"(): AsyncIterator<T>;
                                                                                                                                                                                                                                                                                                                                                              next(): Promise<T[]>;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                          • T
                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                          [asyncIterator] +Lister | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Type Alias Lister<T>

                                                                                                                                                                                                                                                                                                                                                            A generic type for listing. Returns a promise with typed list.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            type Lister<T> = {
                                                                                                                                                                                                                                                                                                                                                                "[asyncIterator]"(): AsyncIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                next(): Promise<T[]>;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • T
                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                            [asyncIterator] next -

                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                            • Returns AsyncIterator<T>

                                                                                                                                                                                                                                                                                                                                                            • Returns Promise<T[]>

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                            • Returns AsyncIterator<T>

                                                                                                                                                                                                                                                                                                                                                            • Returns Promise<T[]>

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/jetstream/types/LostStreamData.html b/docs/jetstream/types/LostStreamData.html index de1190af..96b27ccc 100644 --- a/docs/jetstream/types/LostStreamData.html +++ b/docs/jetstream/types/LostStreamData.html @@ -1,6 +1,6 @@ LostStreamData | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Type Alias LostStreamData

                                                                                                                                                                                                                                                                                                                                                              Records messages that were damaged and unrecoverable

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              type LostStreamData = {
                                                                                                                                                                                                                                                                                                                                                                  bytes: number;
                                                                                                                                                                                                                                                                                                                                                                  msgs: number[] | null;
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              bytes +
                                                                                                                                                                                                                                                                                                                                                              type LostStreamData = {
                                                                                                                                                                                                                                                                                                                                                                  bytes: number;
                                                                                                                                                                                                                                                                                                                                                                  msgs: number[] | null;
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              bytes msgs

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              bytes: number

                                                                                                                                                                                                                                                                                                                                                              The number of bytes that were lost

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              msgs: number[] | null

                                                                                                                                                                                                                                                                                                                                                              The messages that were lost

                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              msgs: number[] | null

                                                                                                                                                                                                                                                                                                                                                              The messages that were lost

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/MaxBytes.html b/docs/jetstream/types/MaxBytes.html index 7f66c6b7..44d5fa76 100644 --- a/docs/jetstream/types/MaxBytes.html +++ b/docs/jetstream/types/MaxBytes.html @@ -1,5 +1,5 @@ -MaxBytes | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Type Alias MaxBytes

                                                                                                                                                                                                                                                                                                                                                                type MaxBytes = {
                                                                                                                                                                                                                                                                                                                                                                    max_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                max_bytes +MaxBytes | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Type Alias MaxBytes

                                                                                                                                                                                                                                                                                                                                                                  type MaxBytes = {
                                                                                                                                                                                                                                                                                                                                                                      max_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  max_bytes

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  max_bytes: number

                                                                                                                                                                                                                                                                                                                                                                  Maximum number of bytes to retrieve - note request must fit the entire message to be honored (this includes, subject, headers, etc). Partial messages are not supported.

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/MaxMessages.html b/docs/jetstream/types/MaxMessages.html index b0671a5b..0bdf3cc2 100644 --- a/docs/jetstream/types/MaxMessages.html +++ b/docs/jetstream/types/MaxMessages.html @@ -1,6 +1,6 @@ -MaxMessages | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Type Alias MaxMessages

                                                                                                                                                                                                                                                                                                                                                                    type MaxMessages = {
                                                                                                                                                                                                                                                                                                                                                                        max_messages: number;
                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    max_messages +MaxMessages | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      Type Alias MaxMessages

                                                                                                                                                                                                                                                                                                                                                                      type MaxMessages = {
                                                                                                                                                                                                                                                                                                                                                                          max_messages: number;
                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      max_messages

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      max_messages: number

                                                                                                                                                                                                                                                                                                                                                                      Maximum number of messages to retrieve.

                                                                                                                                                                                                                                                                                                                                                                      100 messages
                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/MsgDeleteRequest.html b/docs/jetstream/types/MsgDeleteRequest.html index 3935780d..ef20318c 100644 --- a/docs/jetstream/types/MsgDeleteRequest.html +++ b/docs/jetstream/types/MsgDeleteRequest.html @@ -1,3 +1,3 @@ MsgDeleteRequest | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        Type Alias MsgDeleteRequest

                                                                                                                                                                                                                                                                                                                                                                        MsgDeleteRequest: SeqMsgRequest & { no_erase?: boolean }

                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                        • Optionalno_erase?: boolean

                                                                                                                                                                                                                                                                                                                                                                          Default will securely remove a message and rewrite the data with random data, set this to true to only remove the message

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/MsgRequest.html b/docs/jetstream/types/MsgRequest.html index 90d8a7ac..9719c5bf 100644 --- a/docs/jetstream/types/MsgRequest.html +++ b/docs/jetstream/types/MsgRequest.html @@ -1 +1 @@ -MsgRequest | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          Type Alias MsgRequest

                                                                                                                                                                                                                                                                                                                                                                          MsgRequest: SeqMsgRequest | LastForMsgRequest

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                          +MsgRequest | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            Type Alias MsgRequest

                                                                                                                                                                                                                                                                                                                                                                            MsgRequest: SeqMsgRequest | LastForMsgRequest

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/jetstream/types/Next.html b/docs/jetstream/types/Next.html index c5cfe303..cac41b57 100644 --- a/docs/jetstream/types/Next.html +++ b/docs/jetstream/types/Next.html @@ -1,6 +1,6 @@ Next | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              Type Alias Next

                                                                                                                                                                                                                                                                                                                                                                              Notifies whenever there's a request for additional messages from the server. This notification telegraphs the request options, which should be treated as read-only. This notification is only useful for debugging. Data is PullOptions.

                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                              type Next = {
                                                                                                                                                                                                                                                                                                                                                                                  options: PullOptions;
                                                                                                                                                                                                                                                                                                                                                                                  type: "next";
                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              options +
                                                                                                                                                                                                                                                                                                                                                                              type Next = {
                                                                                                                                                                                                                                                                                                                                                                                  options: PullOptions;
                                                                                                                                                                                                                                                                                                                                                                                  type: "next";
                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              options type -

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              options: PullOptions
                                                                                                                                                                                                                                                                                                                                                                              type: "next"

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              options: PullOptions
                                                                                                                                                                                                                                                                                                                                                                              type: "next"

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/NextMsgRequest.html b/docs/jetstream/types/NextMsgRequest.html index 8ac6bae6..724b7450 100644 --- a/docs/jetstream/types/NextMsgRequest.html +++ b/docs/jetstream/types/NextMsgRequest.html @@ -1,4 +1,4 @@ NextMsgRequest | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                Type Alias NextMsgRequest

                                                                                                                                                                                                                                                                                                                                                                                Request the first message matching specified subject found on or after the specified optional sequence.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                type NextMsgRequest = {
                                                                                                                                                                                                                                                                                                                                                                                    next_by_subj: string;
                                                                                                                                                                                                                                                                                                                                                                                    seq?: number;
                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                next_by_subj +
                                                                                                                                                                                                                                                                                                                                                                                type NextMsgRequest = {
                                                                                                                                                                                                                                                                                                                                                                                    next_by_subj: string;
                                                                                                                                                                                                                                                                                                                                                                                    seq?: number;
                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                next_by_subj seq? -

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                next_by_subj: string
                                                                                                                                                                                                                                                                                                                                                                                seq?: number

                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                next_by_subj: string
                                                                                                                                                                                                                                                                                                                                                                                seq?: number

                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/jetstream/types/NextOptions.html b/docs/jetstream/types/NextOptions.html index d85e213b..42d5da8a 100644 --- a/docs/jetstream/types/NextOptions.html +++ b/docs/jetstream/types/NextOptions.html @@ -1 +1 @@ -NextOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Type Alias NextOptions

                                                                                                                                                                                                                                                                                                                                                                                  NextOptions: Expires & Bind

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                  +NextOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Type Alias NextOptions

                                                                                                                                                                                                                                                                                                                                                                                    NextOptions: Expires & Bind

                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/jetstream/types/NoResponders.html b/docs/jetstream/types/NoResponders.html index cc20f3f9..168d0985 100644 --- a/docs/jetstream/types/NoResponders.html +++ b/docs/jetstream/types/NoResponders.html @@ -1,5 +1,5 @@ NoResponders | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Type Alias NoResponders

                                                                                                                                                                                                                                                                                                                                                                                      Notification that a JetStream request didn't get a response due to a timeout or JetStream not being available.

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      type NoResponders = {
                                                                                                                                                                                                                                                                                                                                                                                          code: number;
                                                                                                                                                                                                                                                                                                                                                                                          type: "no_responders";
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      code +
                                                                                                                                                                                                                                                                                                                                                                                      type NoResponders = {
                                                                                                                                                                                                                                                                                                                                                                                          code: number;
                                                                                                                                                                                                                                                                                                                                                                                          type: "no_responders";
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      code type -

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      code: number
                                                                                                                                                                                                                                                                                                                                                                                      type: "no_responders"

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      code: number
                                                                                                                                                                                                                                                                                                                                                                                      type: "no_responders"

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/OrderedConsumerOptions.html b/docs/jetstream/types/OrderedConsumerOptions.html index 08f7eb29..27452336 100644 --- a/docs/jetstream/types/OrderedConsumerOptions.html +++ b/docs/jetstream/types/OrderedConsumerOptions.html @@ -1,6 +1,6 @@ OrderedConsumerOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                        Type Alias OrderedConsumerOptions

                                                                                                                                                                                                                                                                                                                                                                                        These options are a subset of ConsumerConfig and ConsumerUpdateConfig

                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        type OrderedConsumerOptions = {
                                                                                                                                                                                                                                                                                                                                                                                            deliver_policy: DeliverPolicy;
                                                                                                                                                                                                                                                                                                                                                                                            filter_subjects: string[] | string;
                                                                                                                                                                                                                                                                                                                                                                                            headers_only: boolean;
                                                                                                                                                                                                                                                                                                                                                                                            inactive_threshold: number;
                                                                                                                                                                                                                                                                                                                                                                                            name_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                            opt_start_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                            opt_start_time: string;
                                                                                                                                                                                                                                                                                                                                                                                            replay_policy: ReplayPolicy;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        deliver_policy +
                                                                                                                                                                                                                                                                                                                                                                                        type OrderedConsumerOptions = {
                                                                                                                                                                                                                                                                                                                                                                                            deliver_policy: DeliverPolicy;
                                                                                                                                                                                                                                                                                                                                                                                            filter_subjects: string[] | string;
                                                                                                                                                                                                                                                                                                                                                                                            headers_only: boolean;
                                                                                                                                                                                                                                                                                                                                                                                            inactive_threshold: number;
                                                                                                                                                                                                                                                                                                                                                                                            name_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                            opt_start_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                            opt_start_time: string;
                                                                                                                                                                                                                                                                                                                                                                                            replay_policy: ReplayPolicy;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        deliver_policy filter_subjects headers_only inactive_threshold @@ -8,4 +8,4 @@ opt_start_seq opt_start_time replay_policy -

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        deliver_policy: DeliverPolicy
                                                                                                                                                                                                                                                                                                                                                                                        filter_subjects: string[] | string
                                                                                                                                                                                                                                                                                                                                                                                        headers_only: boolean
                                                                                                                                                                                                                                                                                                                                                                                        inactive_threshold: number
                                                                                                                                                                                                                                                                                                                                                                                        name_prefix: string
                                                                                                                                                                                                                                                                                                                                                                                        opt_start_seq: number
                                                                                                                                                                                                                                                                                                                                                                                        opt_start_time: string
                                                                                                                                                                                                                                                                                                                                                                                        replay_policy: ReplayPolicy

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        deliver_policy: DeliverPolicy
                                                                                                                                                                                                                                                                                                                                                                                        filter_subjects: string[] | string
                                                                                                                                                                                                                                                                                                                                                                                        headers_only: boolean
                                                                                                                                                                                                                                                                                                                                                                                        inactive_threshold: number
                                                                                                                                                                                                                                                                                                                                                                                        name_prefix: string
                                                                                                                                                                                                                                                                                                                                                                                        opt_start_seq: number
                                                                                                                                                                                                                                                                                                                                                                                        opt_start_time: string
                                                                                                                                                                                                                                                                                                                                                                                        replay_policy: ReplayPolicy

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/OrderedConsumerRecreated.html b/docs/jetstream/types/OrderedConsumerRecreated.html index af5dc501..1a78b872 100644 --- a/docs/jetstream/types/OrderedConsumerRecreated.html +++ b/docs/jetstream/types/OrderedConsumerRecreated.html @@ -1,5 +1,5 @@ OrderedConsumerRecreated | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                          Type Alias OrderedConsumerRecreated

                                                                                                                                                                                                                                                                                                                                                                                          This notification is specific of ordered consumers and will be notified whenever the consumer is recreated. The argument is the name of the newly created consumer.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          type OrderedConsumerRecreated = {
                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                              type: "ordered_consumer_recreated";
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          name +
                                                                                                                                                                                                                                                                                                                                                                                          type OrderedConsumerRecreated = {
                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                              type: "ordered_consumer_recreated";
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          name type -

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          name: string
                                                                                                                                                                                                                                                                                                                                                                                          type: "ordered_consumer_recreated"

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          name: string
                                                                                                                                                                                                                                                                                                                                                                                          type: "ordered_consumer_recreated"

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/OrderedPushConsumerOptions.html b/docs/jetstream/types/OrderedPushConsumerOptions.html index 8390ea7f..6ada8885 100644 --- a/docs/jetstream/types/OrderedPushConsumerOptions.html +++ b/docs/jetstream/types/OrderedPushConsumerOptions.html @@ -1 +1 @@ -OrderedPushConsumerOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                            Type Alias OrderedPushConsumerOptions

                                                                                                                                                                                                                                                                                                                                                                                            OrderedPushConsumerOptions: OrderedConsumerOptions & { deliver_prefix: string }

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                            +OrderedPushConsumerOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias OrderedPushConsumerOptions

                                                                                                                                                                                                                                                                                                                                                                                              OrderedPushConsumerOptions: OrderedConsumerOptions & { deliver_prefix: string }

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/OverflowMinAckPending.html b/docs/jetstream/types/OverflowMinAckPending.html index 2f1c1753..34086710 100644 --- a/docs/jetstream/types/OverflowMinAckPending.html +++ b/docs/jetstream/types/OverflowMinAckPending.html @@ -1,5 +1,5 @@ -OverflowMinAckPending | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                Type Alias OverflowMinAckPending

                                                                                                                                                                                                                                                                                                                                                                                                type OverflowMinAckPending = {
                                                                                                                                                                                                                                                                                                                                                                                                    group: string;
                                                                                                                                                                                                                                                                                                                                                                                                    min_ack_pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                group +OverflowMinAckPending | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias OverflowMinAckPending

                                                                                                                                                                                                                                                                                                                                                                                                  type OverflowMinAckPending = {
                                                                                                                                                                                                                                                                                                                                                                                                      group: string;
                                                                                                                                                                                                                                                                                                                                                                                                      min_ack_pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  group min_ack_pending

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  group: string

                                                                                                                                                                                                                                                                                                                                                                                                  The name of the priority_group

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  min_ack_pending: number

                                                                                                                                                                                                                                                                                                                                                                                                  Only deliver messages when num_ack_pending for the consumer is greater than this value

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  min_ack_pending: number

                                                                                                                                                                                                                                                                                                                                                                                                  Only deliver messages when num_ack_pending for the consumer is greater than this value

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/OverflowMinPending.html b/docs/jetstream/types/OverflowMinPending.html index 33331f82..23bfcb2c 100644 --- a/docs/jetstream/types/OverflowMinPending.html +++ b/docs/jetstream/types/OverflowMinPending.html @@ -1,5 +1,5 @@ -OverflowMinPending | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias OverflowMinPending

                                                                                                                                                                                                                                                                                                                                                                                                    type OverflowMinPending = {
                                                                                                                                                                                                                                                                                                                                                                                                        group: string;
                                                                                                                                                                                                                                                                                                                                                                                                        min_pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                    group +OverflowMinPending | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias OverflowMinPending

                                                                                                                                                                                                                                                                                                                                                                                                      type OverflowMinPending = {
                                                                                                                                                                                                                                                                                                                                                                                                          group: string;
                                                                                                                                                                                                                                                                                                                                                                                                          min_pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      group min_pending

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      group: string

                                                                                                                                                                                                                                                                                                                                                                                                      The name of the priority_group

                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      min_pending: number

                                                                                                                                                                                                                                                                                                                                                                                                      Only deliver messages when num_pending for the consumer is greater than this value

                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      min_pending: number

                                                                                                                                                                                                                                                                                                                                                                                                      Only deliver messages when num_pending for the consumer is greater than this value

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/OverflowMinPendingAndMinAck.html b/docs/jetstream/types/OverflowMinPendingAndMinAck.html index 35699b0f..51a936a4 100644 --- a/docs/jetstream/types/OverflowMinPendingAndMinAck.html +++ b/docs/jetstream/types/OverflowMinPendingAndMinAck.html @@ -1,7 +1,7 @@ -OverflowMinPendingAndMinAck | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias OverflowMinPendingAndMinAck

                                                                                                                                                                                                                                                                                                                                                                                                        type OverflowMinPendingAndMinAck = {
                                                                                                                                                                                                                                                                                                                                                                                                            group: string;
                                                                                                                                                                                                                                                                                                                                                                                                            min_ack_pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                            min_pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                        group +OverflowMinPendingAndMinAck | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias OverflowMinPendingAndMinAck

                                                                                                                                                                                                                                                                                                                                                                                                          type OverflowMinPendingAndMinAck = {
                                                                                                                                                                                                                                                                                                                                                                                                              group: string;
                                                                                                                                                                                                                                                                                                                                                                                                              min_ack_pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                              min_pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          group min_ack_pending min_pending

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          group: string

                                                                                                                                                                                                                                                                                                                                                                                                          The name of the priority_group

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          min_ack_pending: number

                                                                                                                                                                                                                                                                                                                                                                                                          Only deliver messages when num_ack_pending for the consumer is greater than this value

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          min_pending: number

                                                                                                                                                                                                                                                                                                                                                                                                          Only deliver messages when num_pending for the consumer is greater than this value

                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          min_ack_pending: number

                                                                                                                                                                                                                                                                                                                                                                                                          Only deliver messages when num_ack_pending for the consumer is greater than this value

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          min_pending: number

                                                                                                                                                                                                                                                                                                                                                                                                          Only deliver messages when num_pending for the consumer is greater than this value

                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/OverflowOptions.html b/docs/jetstream/types/OverflowOptions.html index a92d2958..5c268e08 100644 --- a/docs/jetstream/types/OverflowOptions.html +++ b/docs/jetstream/types/OverflowOptions.html @@ -1 +1 @@ -OverflowOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias OverflowOptions

                                                                                                                                                                                                                                                                                                                                                                                                            OverflowOptions:
                                                                                                                                                                                                                                                                                                                                                                                                                | OverflowMinPending
                                                                                                                                                                                                                                                                                                                                                                                                                | OverflowMinAckPending
                                                                                                                                                                                                                                                                                                                                                                                                                | OverflowMinPendingAndMinAck

                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                            +OverflowOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias OverflowOptions

                                                                                                                                                                                                                                                                                                                                                                                                              OverflowOptions:
                                                                                                                                                                                                                                                                                                                                                                                                                  | OverflowMinPending
                                                                                                                                                                                                                                                                                                                                                                                                                  | OverflowMinAckPending
                                                                                                                                                                                                                                                                                                                                                                                                                  | OverflowMinPendingAndMinAck

                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/PeerInfo.html b/docs/jetstream/types/PeerInfo.html index f2e7d384..11756863 100644 --- a/docs/jetstream/types/PeerInfo.html +++ b/docs/jetstream/types/PeerInfo.html @@ -1,11 +1,11 @@ -PeerInfo | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias PeerInfo

                                                                                                                                                                                                                                                                                                                                                                                                                type PeerInfo = {
                                                                                                                                                                                                                                                                                                                                                                                                                    active: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                    current: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                    lag: number;
                                                                                                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                    offline: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                active +PeerInfo | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PeerInfo

                                                                                                                                                                                                                                                                                                                                                                                                                  type PeerInfo = {
                                                                                                                                                                                                                                                                                                                                                                                                                      active: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                      current: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                      lag: number;
                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      offline: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  active current lag name offline

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  active: Nanos

                                                                                                                                                                                                                                                                                                                                                                                                                  Nanoseconds since this peer was last seen

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  current: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  Indicates if the server is up-to-date and synchronised

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  lag: number

                                                                                                                                                                                                                                                                                                                                                                                                                  How many uncommitted operations this peer is behind the leader

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  name: string

                                                                                                                                                                                                                                                                                                                                                                                                                  The server name of the peer

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  offline: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  Indicates the node is considered offline by the group

                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  current: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  Indicates if the server is up-to-date and synchronised

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  lag: number

                                                                                                                                                                                                                                                                                                                                                                                                                  How many uncommitted operations this peer is behind the leader

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  name: string

                                                                                                                                                                                                                                                                                                                                                                                                                  The server name of the peer

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  offline: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  Indicates the node is considered offline by the group

                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/PersistMode.html b/docs/jetstream/types/PersistMode.html new file mode 100644 index 00000000..bc10399e --- /dev/null +++ b/docs/jetstream/types/PersistMode.html @@ -0,0 +1 @@ +PersistMode | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PersistMode

                                                                                                                                                                                                                                                                                                                                                                                                                    PersistMode: typeof PersistMode[keyof typeof PersistMode]

                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/jetstream/types/Placement.html b/docs/jetstream/types/Placement.html index ed976b05..872ab454 100644 --- a/docs/jetstream/types/Placement.html +++ b/docs/jetstream/types/Placement.html @@ -1,5 +1,5 @@ -Placement | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Placement

                                                                                                                                                                                                                                                                                                                                                                                                                      type Placement = {
                                                                                                                                                                                                                                                                                                                                                                                                                          cluster: string;
                                                                                                                                                                                                                                                                                                                                                                                                                          tags: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                      cluster +Placement | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Placement

                                                                                                                                                                                                                                                                                                                                                                                                                        type Placement = {
                                                                                                                                                                                                                                                                                                                                                                                                                            cluster: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            tags: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        cluster tags

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        cluster: string

                                                                                                                                                                                                                                                                                                                                                                                                                        The cluster to place the stream on

                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        tags: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                        Tags matching server configuration

                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        tags: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                        Tags matching server configuration

                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/PrioritizedOptions.html b/docs/jetstream/types/PrioritizedOptions.html new file mode 100644 index 00000000..4ee8d2f0 --- /dev/null +++ b/docs/jetstream/types/PrioritizedOptions.html @@ -0,0 +1,3 @@ +PrioritizedOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PrioritizedOptions

                                                                                                                                                                                                                                                                                                                                                                                                                          type PrioritizedOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                              group: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              priority: number;
                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                          group +priority +

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                          group: string
                                                                                                                                                                                                                                                                                                                                                                                                                          priority: number

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/PriorityGroups.html b/docs/jetstream/types/PriorityGroups.html index 74607d16..7e9337e3 100644 --- a/docs/jetstream/types/PriorityGroups.html +++ b/docs/jetstream/types/PriorityGroups.html @@ -1,4 +1,4 @@ -PriorityGroups | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias PriorityGroups

                                                                                                                                                                                                                                                                                                                                                                                                                            type PriorityGroups = {
                                                                                                                                                                                                                                                                                                                                                                                                                                priority_groups?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                priority_policy?: PriorityPolicy;
                                                                                                                                                                                                                                                                                                                                                                                                                                priority_timeout?: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                            priority_groups? +PriorityGroups | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias PriorityGroups

                                                                                                                                                                                                                                                                                                                                                                                                                              type PriorityGroups = {
                                                                                                                                                                                                                                                                                                                                                                                                                                  priority_groups?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                  priority_policy?: PriorityPolicy;
                                                                                                                                                                                                                                                                                                                                                                                                                                  priority_timeout?: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                              priority_groups? priority_policy? priority_timeout? -

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                              priority_groups?: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                              priority_policy?: PriorityPolicy
                                                                                                                                                                                                                                                                                                                                                                                                                              priority_timeout?: Nanos

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                              priority_groups?: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                              priority_policy?: PriorityPolicy
                                                                                                                                                                                                                                                                                                                                                                                                                              priority_timeout?: Nanos

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/PriorityPolicy.html b/docs/jetstream/types/PriorityPolicy.html index f8bb8671..af62013e 100644 --- a/docs/jetstream/types/PriorityPolicy.html +++ b/docs/jetstream/types/PriorityPolicy.html @@ -1 +1 @@ -PriorityPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias PriorityPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                PriorityPolicy: typeof PriorityPolicy[keyof typeof PriorityPolicy]

                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                +PriorityPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PriorityPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                  PriorityPolicy: typeof PriorityPolicy[keyof typeof PriorityPolicy]

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/PubAck.html b/docs/jetstream/types/PubAck.html index 7d72303c..61897374 100644 --- a/docs/jetstream/types/PubAck.html +++ b/docs/jetstream/types/PubAck.html @@ -1,10 +1,10 @@ PubAck | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PubAck

                                                                                                                                                                                                                                                                                                                                                                                                                                    The response returned by the JetStream server when a message is added to a stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    type PubAck = {
                                                                                                                                                                                                                                                                                                                                                                                                                                        domain?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        duplicate: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                        stream: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                    domain? +
                                                                                                                                                                                                                                                                                                                                                                                                                                    type PubAck = {
                                                                                                                                                                                                                                                                                                                                                                                                                                        domain?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        duplicate: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                        stream: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                    domain? duplicate seq stream

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                    domain?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The domain of the JetStream

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    duplicate: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                    True if the message is a duplicate

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                    The sequence number of the message as stored in JetStream

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    stream: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the stream

                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    duplicate: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                    True if the message is a duplicate

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                    The sequence number of the message as stored in JetStream

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    stream: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the stream

                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/jetstream/types/PubHeaders.html b/docs/jetstream/types/PubHeaders.html new file mode 100644 index 00000000..e8f04434 --- /dev/null +++ b/docs/jetstream/types/PubHeaders.html @@ -0,0 +1 @@ +PubHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias PubHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                      PubHeaders: typeof PubHeaders[keyof typeof PubHeaders]

                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/PullOptions.html b/docs/jetstream/types/PullOptions.html index ffe8cf3f..b1d014f9 100644 --- a/docs/jetstream/types/PullOptions.html +++ b/docs/jetstream/types/PullOptions.html @@ -1,11 +1,11 @@ -PullOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PullOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                        PullOptions: Partial<OverflowMinPendingAndMinAck> & {
                                                                                                                                                                                                                                                                                                                                                                                                                                            batch: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                            expires: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                            idle_heartbeat: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                            max_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                            no_wait: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                        Options for a JetStream pull subscription which define how long +PullOptions | @nats-io/jetstream

                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PullOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                          PullOptions: Partial<OverflowMinPendingAndMinAck> & Partial<PrioritizedOptions> & {
                                                                                                                                                                                                                                                                                                                                                                                                                                              batch: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                              expires: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                              idle_heartbeat: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                              max_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                              no_wait: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                          Options for a JetStream pull subscription which define how long the pull request will remain open and limits the amount of data that the server could return.

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                          • batch: number

                                                                                                                                                                                                                                                                                                                                                                                                                                            Max number of messages to retrieve in a pull.

                                                                                                                                                                                                                                                                                                                                                                                                                                          • expires: number

                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the number of milliseconds to wait for the number of messages -specified in batch

                                                                                                                                                                                                                                                                                                                                                                                                                                            +specified in batch

                                                                                                                                                                                                                                                                                                                                                                                                                                          • idle_heartbeat: number

                                                                                                                                                                                                                                                                                                                                                                                                                                            Number of nanos between messages for the server to emit an idle_heartbeat

                                                                                                                                                                                                                                                                                                                                                                                                                                          • max_bytes: number

                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the max number of bytes to receive. The server will limit the number of messages in the batch to fit within this setting.

                                                                                                                                                                                                                                                                                                                                                                                                                                          • no_wait: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                            If true, the request for messages will end when received by the server

                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/PurgeBySeq.html b/docs/jetstream/types/PurgeBySeq.html index 9b188965..de83feaf 100644 --- a/docs/jetstream/types/PurgeBySeq.html +++ b/docs/jetstream/types/PurgeBySeq.html @@ -1,5 +1,5 @@ -PurgeBySeq | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias PurgeBySeq

                                                                                                                                                                                                                                                                                                                                                                                                                                            type PurgeBySeq = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                filter?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                            filter? +PurgeBySeq | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias PurgeBySeq

                                                                                                                                                                                                                                                                                                                                                                                                                                              type PurgeBySeq = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                  filter?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                              filter? seq

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                              filter?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                              Restrict purging to messages that match this subject

                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                              seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                              Purge all messages up to but not including the message with this sequence.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                              Purge all messages up to but not including the message with this sequence.

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/PurgeBySubject.html b/docs/jetstream/types/PurgeBySubject.html index 7b5f2648..c07a13d6 100644 --- a/docs/jetstream/types/PurgeBySubject.html +++ b/docs/jetstream/types/PurgeBySubject.html @@ -1,3 +1,3 @@ -PurgeBySubject | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias PurgeBySubject

                                                                                                                                                                                                                                                                                                                                                                                                                                                type PurgeBySubject = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                filter +PurgeBySubject | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PurgeBySubject

                                                                                                                                                                                                                                                                                                                                                                                                                                                  type PurgeBySubject = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                      filter: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                  filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                  filter: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Restrict purging to messages that match this subject

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/PurgeOpts.html b/docs/jetstream/types/PurgeOpts.html index 722fb32c..d4dde608 100644 --- a/docs/jetstream/types/PurgeOpts.html +++ b/docs/jetstream/types/PurgeOpts.html @@ -1 +1 @@ -PurgeOpts | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PurgeOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                    PurgeOpts: PurgeBySeq | PurgeTrimOpts | PurgeBySubject

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +PurgeOpts | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias PurgeOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                      PurgeOpts: PurgeBySeq | PurgeTrimOpts | PurgeBySubject

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/PurgeResponse.html b/docs/jetstream/types/PurgeResponse.html index 145e78db..93225c8e 100644 --- a/docs/jetstream/types/PurgeResponse.html +++ b/docs/jetstream/types/PurgeResponse.html @@ -1,2 +1,2 @@ PurgeResponse | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PurgeResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                        PurgeResponse: Success & { purged: number }

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • purged: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Number of messages purged from the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/PurgeTrimOpts.html b/docs/jetstream/types/PurgeTrimOpts.html index 3fb8e55e..dbbf7c60 100644 --- a/docs/jetstream/types/PurgeTrimOpts.html +++ b/docs/jetstream/types/PurgeTrimOpts.html @@ -1,5 +1,5 @@ -PurgeTrimOpts | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PurgeTrimOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                          type PurgeTrimOpts = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                              filter?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              keep: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                          filter? +PurgeTrimOpts | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias PurgeTrimOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                            type PurgeTrimOpts = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                filter?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                keep: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter? keep

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Restrict purging to messages that match this subject

                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            keep: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ensures this many messages are present after the purge.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            keep: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ensures this many messages are present after the purge.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/jetstream/types/PushConsumer.html b/docs/jetstream/types/PushConsumer.html index e7d3d155..a8287f2c 100644 --- a/docs/jetstream/types/PushConsumer.html +++ b/docs/jetstream/types/PushConsumer.html @@ -1 +1 @@ -PushConsumer | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias PushConsumer

                                                                                                                                                                                                                                                                                                                                                                                                                                                              PushConsumer: InfoableConsumer & DeleteableConsumer & ConsumerKind & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  consume(opts?: PushConsumerOptions): Promise<ConsumerMessages>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +PushConsumer | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias PushConsumer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                PushConsumer: InfoableConsumer & DeleteableConsumer & ConsumerKind & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consume(opts?: PushConsumerOptions): Promise<ConsumerMessages>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/jetstream/types/PushConsumerOptions.html b/docs/jetstream/types/PushConsumerOptions.html index f873c573..d60e4b9f 100644 --- a/docs/jetstream/types/PushConsumerOptions.html +++ b/docs/jetstream/types/PushConsumerOptions.html @@ -1 +1 @@ -PushConsumerOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PushConsumerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PushConsumerOptions: ConsumeCallback & AbortOnMissingResource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +PushConsumerOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PushConsumerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PushConsumerOptions: ConsumeCallback & AbortOnMissingResource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/jetstream/types/ReplayPolicy.html b/docs/jetstream/types/ReplayPolicy.html index cd6c4968..b432f1b5 100644 --- a/docs/jetstream/types/ReplayPolicy.html +++ b/docs/jetstream/types/ReplayPolicy.html @@ -1 +1 @@ -ReplayPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ReplayPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReplayPolicy: typeof ReplayPolicy[keyof typeof ReplayPolicy]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +ReplayPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ReplayPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ReplayPolicy: typeof ReplayPolicy[keyof typeof ReplayPolicy]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/Republish.html b/docs/jetstream/types/Republish.html index e9930f4d..0e24725f 100644 --- a/docs/jetstream/types/Republish.html +++ b/docs/jetstream/types/Republish.html @@ -1,7 +1,7 @@ -Republish | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Republish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Republish = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dest: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              headers_only?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              src: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          dest +Republish | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Republish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Republish = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                dest: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                headers_only?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                src: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            dest headers_only? src

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            dest: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The destination to publish to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            headers_only?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Only send message headers, no bodies

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            src: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The source subject to republish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            headers_only?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Only send message headers, no bodies

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            src: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The source subject to republish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/jetstream/types/RepublishHeaders.html b/docs/jetstream/types/RepublishHeaders.html index 1a311824..0301f98a 100644 --- a/docs/jetstream/types/RepublishHeaders.html +++ b/docs/jetstream/types/RepublishHeaders.html @@ -1 +1 @@ -RepublishHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias RepublishHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RepublishHeaders: typeof RepublishHeaders[keyof typeof RepublishHeaders]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +RepublishHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias RepublishHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                RepublishHeaders: typeof RepublishHeaders[keyof typeof RepublishHeaders]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/jetstream/types/Reset.html b/docs/jetstream/types/Reset.html index 436b4fc2..d7ef5899 100644 --- a/docs/jetstream/types/Reset.html +++ b/docs/jetstream/types/Reset.html @@ -1,4 +1,4 @@ Reset | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Notifies that the current consumer will be reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Reset = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: "reset";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Reset = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: "reset";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name type -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type: "reset"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type: "reset"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/RetentionPolicy.html b/docs/jetstream/types/RetentionPolicy.html index 20721ed1..74d964eb 100644 --- a/docs/jetstream/types/RetentionPolicy.html +++ b/docs/jetstream/types/RetentionPolicy.html @@ -1 +1 @@ -RetentionPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias RetentionPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RetentionPolicy: typeof RetentionPolicy[keyof typeof RetentionPolicy]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +RetentionPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias RetentionPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetentionPolicy: typeof RetentionPolicy[keyof typeof RetentionPolicy]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/ScheduleOptions.html b/docs/jetstream/types/ScheduleOptions.html new file mode 100644 index 00000000..2ee0ebdd --- /dev/null +++ b/docs/jetstream/types/ScheduleOptions.html @@ -0,0 +1,13 @@ +ScheduleOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ScheduleOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type ScheduleOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            source?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            specification: string | Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            target: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ttl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        source? +specification +target +ttl? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        source?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Instructs the schedule to read the last message on the given subject and publish. If the subject is empty, nothing is published. Wildcards are NOT supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        specification: string | Date

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The schedule specification format. +Currently only supports: +"@at " - e.g., new Date(Date.now() + 60_000).toISOString()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Note: The ADR-51 specification defines additional formats that may be supported in future +server versions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        target: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The subject the message will be delivered to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ttl?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets a message TTL if the stream supports per-message TTL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/SeqMsgRequest.html b/docs/jetstream/types/SeqMsgRequest.html index 3088ea29..94e6e0c6 100644 --- a/docs/jetstream/types/SeqMsgRequest.html +++ b/docs/jetstream/types/SeqMsgRequest.html @@ -1,3 +1,3 @@ SeqMsgRequest | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias SeqMsgRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Stream sequence number of the message to retrieve

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type SeqMsgRequest = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          seq -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type SeqMsgRequest = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          seq +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/SequenceInfo.html b/docs/jetstream/types/SequenceInfo.html index 7741c7d4..dc5784a9 100644 --- a/docs/jetstream/types/SequenceInfo.html +++ b/docs/jetstream/types/SequenceInfo.html @@ -1,4 +1,4 @@ -SequenceInfo | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias SequenceInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type SequenceInfo = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                consumer_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                last_active: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                stream_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            consumer_seq +SequenceInfo | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias SequenceInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type SequenceInfo = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  consumer_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  last_active: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stream_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              consumer_seq last_active stream_seq -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              consumer_seq: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              last_active: Nanos
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stream_seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              consumer_seq: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              last_active: Nanos
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stream_seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/StartTimeMsgRequest.html b/docs/jetstream/types/StartTimeMsgRequest.html index cc0a0d5b..6ff23824 100644 --- a/docs/jetstream/types/StartTimeMsgRequest.html +++ b/docs/jetstream/types/StartTimeMsgRequest.html @@ -1,4 +1,4 @@ StartTimeMsgRequest | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias StartTimeMsgRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Start time for the message. This is only supported on servers 2.11.0 and better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type StartTimeMsgRequest = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    start_time: Date | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                start_time -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                start_time: Date | string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type StartTimeMsgRequest = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    start_time: Date | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                start_time +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                start_time: Date | string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/jetstream/types/StorageType.html b/docs/jetstream/types/StorageType.html index 27db4ffb..bda2efb6 100644 --- a/docs/jetstream/types/StorageType.html +++ b/docs/jetstream/types/StorageType.html @@ -1 +1 @@ -StorageType | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias StorageType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  StorageType: typeof StorageType[keyof typeof StorageType]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +StorageType | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias StorageType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StorageType: typeof StorageType[keyof typeof StorageType]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/jetstream/types/StoreCompression.html b/docs/jetstream/types/StoreCompression.html index 244410da..26b91310 100644 --- a/docs/jetstream/types/StoreCompression.html +++ b/docs/jetstream/types/StoreCompression.html @@ -1 +1 @@ -StoreCompression | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias StoreCompression

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StoreCompression: typeof StoreCompression[keyof typeof StoreCompression]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +StoreCompression | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias StoreCompression

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StoreCompression: typeof StoreCompression[keyof typeof StoreCompression]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/types/StoredMsg.html b/docs/jetstream/types/StoredMsg.html index c44bb53f..33272fe6 100644 --- a/docs/jetstream/types/StoredMsg.html +++ b/docs/jetstream/types/StoredMsg.html @@ -1,5 +1,5 @@ StoredMsg | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias StoredMsg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A type representing a message that retrieved directly from JetStream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type StoredMsg = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              data: Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              header: MsgHdrs;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lastSequence: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subject: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              time: Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timestamp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              json<T>(reviver?: ReviverFn): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          data +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type StoredMsg = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              data: Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              header: MsgHdrs;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lastSequence: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pending: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subject: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              time: Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timestamp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              json<T>(reviver?: ReviverFn): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          data header lastSequence pending @@ -10,18 +10,18 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          json string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          data: Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The payload of the message body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          header: MsgHdrs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Headers for the message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          lastSequence: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The previous sequence delivered to the client in the current batch. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          header: MsgHdrs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Headers for the message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          lastSequence: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The previous sequence delivered to the client in the current batch. This value will be 0 if it was not from a batch request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pending: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The number of messages in the stream that are pending for a similar +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pending: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The number of messages in the stream that are pending for a similar batch request. if -1, the number of pending messages is unknown and the stored message was received outside the context of a batch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The sequence number of the message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subject: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The subject the message was originally received on

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          time: Date

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The time the message was received

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          timestamp: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The raw ISO formatted date returned by the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Convenience method to parse the message payload as JSON. This method +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The sequence number of the message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subject: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The subject the message was originally received on

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          time: Date

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The time the message was received

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          timestamp: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The raw ISO formatted date returned by the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Convenience method to parse the message payload as JSON. This method will throw an exception if there's a parsing error;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalreviver: ReviverFn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Convenience method to parse the message payload as string. This method +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalreviver: ReviverFn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Convenience method to parse the message payload as string. This method may throw an exception if there's a conversion error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/Stream.html b/docs/jetstream/types/Stream.html index 73902f34..e8580a94 100644 --- a/docs/jetstream/types/Stream.html +++ b/docs/jetstream/types/Stream.html @@ -1,4 +1,4 @@ -Stream | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Stream = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                alternates(): Promise<StreamAlternate[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                best(): Promise<Stream>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteMessage(seq: number, erase?: boolean): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getConsumer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name?: string | Partial<OrderedConsumerOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<Consumer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getMessage(query: MsgRequest): Promise<StoredMsg>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getPushConsumer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    stream: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name?: string | Partial<OrderedPushConsumerOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PushConsumer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                info(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cached?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    opts?: Partial<StreamInfoRequestOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name +Stream | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Stream = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  alternates(): Promise<StreamAlternate[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  best(): Promise<Stream>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteMessage(seq: number, erase?: boolean): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getConsumer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string | Partial<OrderedConsumerOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<Consumer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getMessage(query: MsgRequest): Promise<StoredMsg>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getPushConsumer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      stream: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string | Partial<OrderedPushConsumerOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PushConsumer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  info(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cached?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      opts?: Partial<StreamInfoRequestOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              alternates best deleteMessage @@ -6,7 +6,7 @@ getMessage getPushConsumer info -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns Promise<Stream>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • seq: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalerase: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns Promise<Stream>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • seq: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalerase: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns the named consumer pull consumer. If instead of a name an OrderedConsumerOptions configuration is passed, an ordered pull consumer is created and returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<Consumer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<Consumer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/StreamAPI.html b/docs/jetstream/types/StreamAPI.html index b5599515..164955e9 100644 --- a/docs/jetstream/types/StreamAPI.html +++ b/docs/jetstream/types/StreamAPI.html @@ -1,4 +1,4 @@ -StreamAPI | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias StreamAPI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type StreamAPI = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    add(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cfg: WithRequired<Partial<StreamConfig>, "name">,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    delete(stream: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteMessage(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stream: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        seq: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        erase?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    find(subject: string): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get(name: string): Promise<Stream>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getMessage(stream: string, query: MsgRequest): Promise<StoredMsg>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    info(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stream: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        opts?: Partial<StreamInfoRequestOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    list(subject?: string): Lister<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    names(subject?: string): Lister<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    purge(stream: string, opts?: PurgeOpts): Promise<PurgeResponse>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    update(name: string, cfg: Partial<StreamUpdateConfig>): Promise<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                add +StreamAPI | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias StreamAPI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type StreamAPI = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      add(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cfg: WithRequired<Partial<StreamConfig>, "name">,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      delete(stream: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteMessage(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          stream: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          seq: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          erase?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      find(subject: string): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      get(name: string): Promise<Stream>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getMessage(stream: string, query: MsgRequest): Promise<StoredMsg>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      info(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          stream: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          opts?: Partial<StreamInfoRequestOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      list(subject?: string): Lister<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      names(subject?: string): Lister<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      purge(stream: string, opts?: PurgeOpts): Promise<PurgeResponse>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      update(name: string, cfg: Partial<StreamUpdateConfig>): Promise<StreamInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  add delete deleteMessage find @@ -10,19 +10,19 @@ purge update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Adds a new stream with the specified stream configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<StreamInfo>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Deletes the specified stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • stream: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Deletes the specified message sequence from the stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<StreamInfo>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Deletes the specified stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • stream: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Deletes the specified message sequence from the stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • stream: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • seq: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalerase: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      erase the message - by default true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Find the stream that stores the specified subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • subject: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns a Stream object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<Stream>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Retrieves the message matching the specified query. Messages can be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Find the stream that stores the specified subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • subject: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns a Stream object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<Stream>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Retrieves the message matching the specified query. Messages can be retrieved by sequence number or by last sequence matching a subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<StoredMsg>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Lists all streams stored by JetStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<StoredMsg>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Lists all streams stored by JetStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalsubject: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      only return streams that include the specified subject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Lister<StreamInfo>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Return a Lister of stream names

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Lister<StreamInfo>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Return a Lister of stream names

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalsubject: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      if specified, the results are filtered to streams that contain the subject (can be wildcarded)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Lister<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Purges messages from a stream that match the specified purge options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<PurgeResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Lister<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Purges messages from a stream that match the specified purge options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<PurgeResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/StreamConfig.html b/docs/jetstream/types/StreamConfig.html index dd3922fb..6c1de310 100644 --- a/docs/jetstream/types/StreamConfig.html +++ b/docs/jetstream/types/StreamConfig.html @@ -1,10 +1,15 @@ -StreamConfig | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias StreamConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StreamConfig: StreamUpdateConfig & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        first_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        max_consumers: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        mirror?: StreamSource;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        retention: RetentionPolicy;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sealed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        storage: StorageType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • first_seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the first sequence number used by the stream. This property can only be +StreamConfig | @nats-io/jetstream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias StreamConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StreamConfig: StreamUpdateConfig & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allow_atomic: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allow_msg_counter: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allow_msg_schedules: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allow_msg_ttl: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            first_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max_consumers: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            persist_mode: PersistMode;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            retention: RetentionPolicy;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sealed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            storage: StorageType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • allow_atomic: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enables the ability to send atomic batches to the stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • allow_msg_counter: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enables a NATS stream implementation of CRDT operations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • allow_msg_schedules: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enables the scheduling of messages in a stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • allow_msg_ttl: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enables allows header initiated per-message TTLs. If disabled, then the NATS-TTL +header will be ignored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • first_seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets the first sequence number used by the stream. This property can only be specified when creating the stream, and likely is not valid on mirrors etc., as it may disrupt the synchronization logic.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max_consumers: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          How many Consumers can be defined for a given Stream. -1 for unlimited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalmirror?: StreamSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Maintains a 1:1 mirror of another stream with name matching this property. -When a mirror is configured subjects and sources must be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A unique name for the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • persist_mode: PersistMode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets the persistence model for the stream - the default is PersistMode.Default. +This is a 2.12 feature.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • retention: RetentionPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          How messages are retained in the Stream, once this is exceeded old messages are removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • sealed: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sealed streams do not allow messages to be deleted via limits or API, sealed streams can not be unsealed via configuration update. diff --git a/docs/jetstream/types/StreamExpectations.html b/docs/jetstream/types/StreamExpectations.html new file mode 100644 index 00000000..672b91bd --- /dev/null +++ b/docs/jetstream/types/StreamExpectations.html @@ -0,0 +1,38 @@ +StreamExpectations | @nats-io/jetstream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias StreamExpectations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            StreamExpectations are used implement some assertions before adding a message +to the stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type StreamExpectations = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lastMsgID: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lastSequence: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lastSubjectSequence: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lastSubjectSequenceSubject: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lastSubjectSequenceValue: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                streamName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastMsgID +lastSequence +lastSubjectSequence +lastSubjectSequenceSubject +lastSubjectSequenceValue +streamName +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastMsgID: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The expected last msgID of the last message received by the stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastSequence: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The expected last sequence on the stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastSubjectSequence: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The expected last sequence on the stream for a message with this subject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastSubjectSequenceSubject: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This option is used in conjunction with lastSubjectSequence. It enables a +constraint on the sequence to be based on the specified subject (which can +have wildcards) rather than the subject of the message being published.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Here's an example set of sequences for specific subjects:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ┌─────────┬────────┐ +│ subj │ Seq │ +├─────────┼────────┤ +│ a.1.foo │ 1 │ +│ a.1.bar │ 6 │ +│ a.2.foo │ 3 │ +│ a.3.bar │ 4 │ +│ a.1.baz │ 5 │ +│ a.2.baz │ 7 │ +└─────────┴────────┘

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The LastSubjectSequenceSubject for wildcards in the last token +Are evaluated for to the largest sequence matching the subject: +┌────────────────────┬────────┐ +| Last Subj Seq Subj | Seq | +├────────────────────┼────────┤ +│ a.1.* │ 6 │ +│ a.2.* │ 7 │ +│ a.3.* │ 4 │ +└────────────────────┴────────┘

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastSubjectSequenceValue: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The expected last sequence on the stream for a message with this subject +and this value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            streamName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The expected stream capturing the message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/jetstream/types/StreamInfoRequestOptions.html b/docs/jetstream/types/StreamInfoRequestOptions.html index e42dc98d..c4817ccb 100644 --- a/docs/jetstream/types/StreamInfoRequestOptions.html +++ b/docs/jetstream/types/StreamInfoRequestOptions.html @@ -1,4 +1,4 @@ StreamInfoRequestOptions | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias StreamInfoRequestOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              StreamInfoRequestOptions: { deleted_details: boolean; subjects_filter: string } & ApiPagedRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Options for StreamAPI info requests

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • deleted_details: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Include info on deleted subjects.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • subjects_filter: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Only include information matching the specified subject filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/jetstream/types/StreamNotFound.html b/docs/jetstream/types/StreamNotFound.html index c387edcb..1a48aa7e 100644 --- a/docs/jetstream/types/StreamNotFound.html +++ b/docs/jetstream/types/StreamNotFound.html @@ -4,7 +4,7 @@ find the consumer. Note that if you get this notification possibly your code should attempt to recreate the consumer. Note that this notification is only informational for ordered consumers, as the consumer will be created in those cases automatically.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type StreamNotFound = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                consumerCreateFails?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type: "stream_not_found";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            consumerCreateFails? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type StreamNotFound = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                consumerCreateFails?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type: "stream_not_found";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            consumerCreateFails? name type -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            consumerCreateFails?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: "stream_not_found"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          consumerCreateFails?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: "stream_not_found"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/StreamSource.html b/docs/jetstream/types/StreamSource.html index 2daa7847..d8143279 100644 --- a/docs/jetstream/types/StreamSource.html +++ b/docs/jetstream/types/StreamSource.html @@ -1,4 +1,4 @@ -StreamSource | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias StreamSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type StreamSource = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                domain?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                external?: ExternalStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                filter_subject?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                opt_start_seq?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                opt_start_time?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                subject_transforms?: SubjectTransformConfig[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            domain? +StreamSource | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias StreamSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type StreamSource = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  domain?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  external?: ExternalStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  filter_subject?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  opt_start_seq?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  opt_start_time?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  subject_transforms?: SubjectTransformConfig[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              domain? external? filter_subject? name @@ -9,12 +9,12 @@ If set, the value here is used to calculate the JetStreamAPI prefix. This field is never serialized to the server. This value cannot be set if external is set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              external?: ExternalStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This value cannot be set if domain is set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              filter_subject?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional filter subject. If the filter matches the message will be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              external?: ExternalStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This value cannot be set if domain is set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              filter_subject?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional filter subject. If the filter matches the message will be on-boarded.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name of the stream source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opt_start_seq?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional start sequence from which to start reading messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opt_start_time?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional start time Date string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subject_transforms?: SubjectTransformConfig[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Apply a subject transforms to sourced messages before doing anything else. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name of the stream source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opt_start_seq?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional start sequence from which to start reading messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opt_start_time?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional start time Date string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subject_transforms?: SubjectTransformConfig[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Apply a subject transforms to sourced messages before doing anything else. This feature only supported on 2.10.x and better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/StreamSourceInfo.html b/docs/jetstream/types/StreamSourceInfo.html index eb211a0e..8290cd30 100644 --- a/docs/jetstream/types/StreamSourceInfo.html +++ b/docs/jetstream/types/StreamSourceInfo.html @@ -1,13 +1,13 @@ StreamSourceInfo | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias StreamSourceInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Information about an upstream stream source in a mirror

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type StreamSourceInfo = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    active: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    error?: ApiError;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lag: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subject_transforms?: SubjectTransformConfig[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                active +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type StreamSourceInfo = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    active: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    error?: ApiError;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lag: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subject_transforms?: SubjectTransformConfig[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                active error? lag name subject_transforms?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                active: Nanos

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When last the mirror had activity, in nanoseconds. Value will be -1 when there has been no activity.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                error?: ApiError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A possible error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lag: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                How many messages behind the mirror operation is

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The name of the Stream being replicated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                subject_transforms?: SubjectTransformConfig[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Apply a subject transforms to sourced messages before doing anything else. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                error?: ApiError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A possible error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lag: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                How many messages behind the mirror operation is

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The name of the Stream being replicated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                subject_transforms?: SubjectTransformConfig[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Apply a subject transforms to sourced messages before doing anything else. This feature only supported on 2.10.x and better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/jetstream/types/StreamState.html b/docs/jetstream/types/StreamState.html index a029ca83..0f3bb051 100644 --- a/docs/jetstream/types/StreamState.html +++ b/docs/jetstream/types/StreamState.html @@ -1,4 +1,4 @@ -StreamState | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias StreamState

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type StreamState = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      consumer_count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleted: number[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      first_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      first_ts: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      last_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      last_ts: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lost: LostStreamData;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      messages: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      num_deleted: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      num_subjects?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subjects?: Record<string, number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  bytes +StreamState | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias StreamState

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type StreamState = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        consumer_count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleted: number[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        first_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        first_ts: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        last_seq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        last_ts: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        lost: LostStreamData;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        messages: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        num_deleted: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        num_subjects?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        subjects?: Record<string, number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bytes consumer_count deleted first_seq @@ -11,17 +11,17 @@ num_subjects? subjects?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bytes: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Combined size of all messages in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consumer_count: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Number of Consumers attached to the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleted: number[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IDs of messages that were deleted using the Message Delete API or Interest-based streams removing messages out of order -StreamInfoRequestOptions.deleted_details is specified on +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consumer_count: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Number of Consumers attached to the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleted: number[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IDs of messages that were deleted using the Message Delete API or Interest-based streams removing messages out of order +when StreamInfoRequestOptions.deleted_details is specified on the request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    first_seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sequence number of the first message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    first_ts: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The ISO timestamp of the first message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    last_seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sequence number of the last message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    last_ts: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The ISO timestamp of the last message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lost: LostStreamData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Messages that were damaged and unrecoverable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    messages: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Number of messages stored in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    num_deleted: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The number of deleted messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    num_subjects?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The number of unique subjects held in the stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subjects?: Record<string, number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Subjects and their message counts when a subjects_filter was set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    first_seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sequence number of the first message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    first_ts: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The ISO timestamp of the first message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    last_seq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sequence number of the last message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    last_ts: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The ISO timestamp of the last message in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lost: LostStreamData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Messages that were damaged and unrecoverable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    messages: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Number of messages stored in the Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    num_deleted: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The number of deleted messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    num_subjects?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The number of unique subjects held in the stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subjects?: Record<string, number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Subjects and their message counts when a subjects_filter was set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/jetstream/types/StreamUpdateConfig.html b/docs/jetstream/types/StreamUpdateConfig.html index 77ec9dc9..c5007a5c 100644 --- a/docs/jetstream/types/StreamUpdateConfig.html +++ b/docs/jetstream/types/StreamUpdateConfig.html @@ -1,5 +1,5 @@ StreamUpdateConfig | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias StreamUpdateConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Stream options that can be updated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type StreamUpdateConfig = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allow_direct: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allow_rollup_hdrs: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          compression?: StoreCompression;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          consumer_limits?: StreamConsumerLimits;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deny_delete: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deny_purge: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          discard: DiscardPolicy;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          discard_new_per_subject: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          duplicate_window: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_age: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_msg_size: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_msgs: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_msgs_per_subject: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          metadata?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mirror_direct: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          no_ack?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          num_replicas: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          placement?: Placement;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          republish?: Republish;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sources?: StreamSource[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subject_transform?: SubjectTransformConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subjects: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allow_direct +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type StreamUpdateConfig = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allow_direct: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allow_rollup_hdrs: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          compression?: StoreCompression;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          consumer_limits?: StreamConsumerLimits;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deny_delete: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deny_purge: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          discard: DiscardPolicy;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          discard_new_per_subject: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          duplicate_window: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_age: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_msg_size: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_msgs: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_msgs_per_subject: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          metadata?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mirror?: StreamSource;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mirror_direct: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          no_ack?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          num_replicas: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          placement?: Placement;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          republish?: Republish;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sources?: StreamSource[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subject_delete_marker_ttl?: Nanos;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subject_transform?: SubjectTransformConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subjects: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allow_direct allow_rollup_hdrs compression? consumer_limits? @@ -15,48 +15,53 @@ max_msgs max_msgs_per_subject metadata? +mirror? mirror_direct no_ack? num_replicas placement? republish? sources? +subject_delete_marker_ttl? subject_transform? subjects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allow_direct: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Allow higher performance, direct access to get individual messages via the $JS.DS.GET API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allow_rollup_hdrs: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Allows the use of the JsHeaders#RollupHdr header to replace all contents of a stream, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allow_rollup_hdrs: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Allows the use of the JsHeaders#RollupHdr header to replace all contents of a stream, or subject in a stream, with a single new message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      compression?: StoreCompression

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the compression level of the stream. This feature is only supported in +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      compression?: StoreCompression

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the compression level of the stream. This feature is only supported in servers 2.10.x and better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      consumer_limits?: StreamConsumerLimits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The consumer limits applied to consumers that don't specify limits +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      consumer_limits?: StreamConsumerLimits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The consumer limits applied to consumers that don't specify limits for inactive_threshold or max_ack_pending. Note that these limits become an upper bound for all clients.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deny_delete: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Restricts the ability to delete messages from a stream via the API. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deny_delete: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deny_purge: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Restricts the ability to purge messages from a stream via the API. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deny_purge: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A short description of the purpose of this stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      discard: DiscardPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      When a Stream reach its limits either old messages are deleted or new ones are denied

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      discard_new_per_subject: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the context of the on a per subject basis. Requires DiscardPolicy#New as the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A short description of the purpose of this stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      discard: DiscardPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      When a Stream reach its limits either old messages are deleted or new ones are denied

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      discard_new_per_subject: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the context of the on a per subject basis. Requires DiscardPolicy#New as the discard policy.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      duplicate_window: Nanos

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The time window to track duplicate messages for, expressed in nanoseconds. 0 for default +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      duplicate_window: Nanos

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The time window to track duplicate messages for, expressed in nanoseconds. 0 for default Set JetStreamPublishOptions#msgID to enable duplicate detection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_age: Nanos

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Maximum age of any message in the stream, expressed in nanoseconds. 0 for unlimited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_bytes: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      How big the Stream may be, when the combined stream size exceeds this old messages are removed. -1 for unlimited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_msg_size: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The largest message that will be accepted by the Stream. -1 for unlimited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_msgs: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      How many messages may be in a Stream, oldest messages will be removed if the Stream exceeds this size. -1 for unlimited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_msgs_per_subject: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      For wildcard streams ensure that for every unique subject this many messages are kept - a per subject retention limit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      metadata?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Metadata field to store additional information about the stream. Note that +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_age: Nanos

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Maximum age of any message in the stream, expressed in nanoseconds. 0 for unlimited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_bytes: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      How big the Stream may be, when the combined stream size exceeds this old messages are removed. -1 for unlimited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_msg_size: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The largest message that will be accepted by the Stream. -1 for unlimited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_msgs: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      How many messages may be in a Stream, oldest messages will be removed if the Stream exceeds this size. -1 for unlimited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      max_msgs_per_subject: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      For wildcard streams ensure that for every unique subject this many messages are kept - a per subject retention limit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      metadata?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Metadata field to store additional information about the stream. Note that keys starting with _nats are reserved. This feature only supported on servers 2.10.x and better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      mirror_direct: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Allow higher performance, direct access to get individual messages via the $JS.DS.GET API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      no_ack?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Disables acknowledging messages that are received by the Stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      num_replicas: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      How many replicas to keep for each message. Min 1, Max 5. Default 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      placement?: Placement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Placement directives to consider when placing replicas of this stream, random placement when unset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      republish?: Republish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Rules for republishing messages from a stream with subject mapping +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      mirror?: StreamSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Maintains a 1:1 mirror of another stream with name matching this property. +When a mirror is configured subjects and sources must be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      mirror_direct: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Allow higher performance, direct access to get individual messages via the $JS.DS.GET API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      no_ack?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Disables acknowledging messages that are received by the Stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      num_replicas: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      How many replicas to keep for each message. Min 1, Max 5. Default 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      placement?: Placement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Placement directives to consider when placing replicas of this stream, random placement when unset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      republish?: Republish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Rules for republishing messages from a stream with subject mapping onto new subjects for partitioning and more

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sources?: StreamSource[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Stream names to replicate into this Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subject_transform?: SubjectTransformConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Apply a subject transform to incoming messages before doing anything else. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sources?: StreamSource[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Stream names to replicate into this Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subject_delete_marker_ttl?: Nanos

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets a duration for adding server markers for delete, purge and max age limits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subject_transform?: SubjectTransformConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Apply a subject transform to incoming messages before doing anything else. This feature only supported on 2.10.x and better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subjects: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A list of subjects to consume, supports wildcards. Must be empty when a mirror is configured. May be empty when sources are configured.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subjects: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A list of subjects to consume, supports wildcards. Must be empty when a mirror is configured. May be empty when sources are configured.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/types/Streams.html b/docs/jetstream/types/Streams.html index e27345ca..10adee36 100644 --- a/docs/jetstream/types/Streams.html +++ b/docs/jetstream/types/Streams.html @@ -1,2 +1,2 @@ -Streams | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Streams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type Streams = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            get(stream: string): Promise<Stream>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • stream: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<Stream>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +Streams | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Streams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Streams = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              get(stream: string): Promise<Stream>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          get +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • stream: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<Stream>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/types/Success.html b/docs/jetstream/types/Success.html index 463cbcc2..33e3daf7 100644 --- a/docs/jetstream/types/Success.html +++ b/docs/jetstream/types/Success.html @@ -1,3 +1,3 @@ -Success | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Success = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                success: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            success +Success | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Success = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  success: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              success: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              True if the operation succeeded

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/types/ThresholdBytes.html b/docs/jetstream/types/ThresholdBytes.html index 063e55c5..ce9758a6 100644 --- a/docs/jetstream/types/ThresholdBytes.html +++ b/docs/jetstream/types/ThresholdBytes.html @@ -1,5 +1,5 @@ -ThresholdBytes | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type ThresholdBytes = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    threshold_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                threshold_bytes -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                threshold_bytes: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Threshold bytes on which the client wil auto-trigger additional message requests +ThresholdBytes | @nats-io/jetstream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type ThresholdBytes = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      threshold_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  threshold_bytes +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  threshold_bytes: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Threshold bytes on which the client auto-triggers additional message requests from the server. This is only applicable to consume.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  75% of MaxBytes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/types/ThresholdMessages.html b/docs/jetstream/types/ThresholdMessages.html index a221622c..bc8482af 100644 --- a/docs/jetstream/types/ThresholdMessages.html +++ b/docs/jetstream/types/ThresholdMessages.html @@ -1,5 +1,5 @@ -ThresholdMessages | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ThresholdMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type ThresholdMessages = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        threshold_messages: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    threshold_messages +ThresholdMessages | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ThresholdMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type ThresholdMessages = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          threshold_messages: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      threshold_messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      threshold_messages: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Threshold message count on which the client will auto-trigger additional requests from the server. This is only applicable to consume.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      75% of MaxMessages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/variables/AckPolicy.html b/docs/jetstream/variables/AckPolicy.html index cffec99e..50e37b20 100644 --- a/docs/jetstream/variables/AckPolicy.html +++ b/docs/jetstream/variables/AckPolicy.html @@ -1,4 +1,4 @@ AckPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable AckPolicyConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        AckPolicy: { All: "all"; Explicit: "explicit"; None: "none" } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyAll: "all"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ack, acknowledges all messages with a lower sequence

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyExplicit: "explicit"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          All sequences must be explicitly acknowledged

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyNone: "none"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Messages don't need to be Ack'ed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/jetstream/variables/AdvisoryKind.html b/docs/jetstream/variables/AdvisoryKind.html index b584cc0a..0b7d25ed 100644 --- a/docs/jetstream/variables/AdvisoryKind.html +++ b/docs/jetstream/variables/AdvisoryKind.html @@ -1,2 +1,2 @@ AdvisoryKind | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable AdvisoryKindConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AdvisoryKind: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Ack: "consumer_ack";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              API: "api_audit";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ConsumerAction: "consumer_action";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ConsumerLeaderElected: "consumer_leader_elected";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ConsumerQuorumLost: "consumer_quorum_lost";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              MaxDeliver: "max_deliver";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RestoreComplete: "restore_complete";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RestoreCreate: "restore_create";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              SnapshotComplete: "snapshot_complete";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              SnapshotCreate: "snapshot_create";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              StreamAction: "stream_action";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              StreamLeaderElected: "stream_leader_elected";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              StreamQuorumLost: "stream_quorum_lost";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Terminated: "terminated";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The different kinds of Advisories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyAck: "consumer_ack"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyAPI: "api_audit"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyConsumerAction: "consumer_action"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyConsumerLeaderElected: "consumer_leader_elected"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyConsumerQuorumLost: "consumer_quorum_lost"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyMaxDeliver: "max_deliver"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyRestoreComplete: "restore_complete"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyRestoreCreate: "restore_create"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlySnapshotComplete: "snapshot_complete"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlySnapshotCreate: "snapshot_create"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyStreamAction: "stream_action"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyStreamLeaderElected: "stream_leader_elected"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyStreamQuorumLost: "stream_quorum_lost"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyTerminated: "terminated"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyAck: "consumer_ack"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyAPI: "api_audit"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyConsumerAction: "consumer_action"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyConsumerLeaderElected: "consumer_leader_elected"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyConsumerQuorumLost: "consumer_quorum_lost"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyMaxDeliver: "max_deliver"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyRestoreComplete: "restore_complete"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyRestoreCreate: "restore_create"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlySnapshotComplete: "snapshot_complete"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlySnapshotCreate: "snapshot_create"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyStreamAction: "stream_action"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyStreamLeaderElected: "stream_leader_elected"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyStreamQuorumLost: "stream_quorum_lost"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyTerminated: "terminated"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/variables/DeliverPolicy.html b/docs/jetstream/variables/DeliverPolicy.html index 6dc6d1f6..3150bd9f 100644 --- a/docs/jetstream/variables/DeliverPolicy.html +++ b/docs/jetstream/variables/DeliverPolicy.html @@ -4,4 +4,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyNew: "new"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Deliver starting with new messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyStartSequence: "by_start_sequence"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Deliver starting with the specified sequence

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyStartTime: "by_start_time"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Deliver starting with the specified time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/variables/DirectMsgHeaders.html b/docs/jetstream/variables/DirectMsgHeaders.html index e10623a3..63be2c40 100644 --- a/docs/jetstream/variables/DirectMsgHeaders.html +++ b/docs/jetstream/variables/DirectMsgHeaders.html @@ -1 +1 @@ -DirectMsgHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable DirectMsgHeadersConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DirectMsgHeaders: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                LastSequence: "Nats-Last-Sequence";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                NumPending: "Nats-Num-Pending";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sequence: "Nats-Sequence";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Stream: "Nats-Stream";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Subject: "Nats-Subject";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                TimeStamp: "Nats-Time-Stamp";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyLastSequence: "Nats-Last-Sequence"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyNumPending: "Nats-Num-Pending"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlySequence: "Nats-Sequence"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyStream: "Nats-Stream"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlySubject: "Nats-Subject"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyTimeStamp: "Nats-Time-Stamp"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +DirectMsgHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable DirectMsgHeadersConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DirectMsgHeaders: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  LastSequence: "Nats-Last-Sequence";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  NumPending: "Nats-Num-Pending";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Sequence: "Nats-Sequence";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Stream: "Nats-Stream";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Subject: "Nats-Subject";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TimeStamp: "Nats-Time-Stamp";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadonlyLastSequence: "Nats-Last-Sequence"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadonlyNumPending: "Nats-Num-Pending"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadonlySequence: "Nats-Sequence"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadonlyStream: "Nats-Stream"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadonlySubject: "Nats-Subject"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadonlyTimeStamp: "Nats-Time-Stamp"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/variables/DiscardPolicy.html b/docs/jetstream/variables/DiscardPolicy.html index 570381cd..e5e1c02a 100644 --- a/docs/jetstream/variables/DiscardPolicy.html +++ b/docs/jetstream/variables/DiscardPolicy.html @@ -1,3 +1,3 @@ DiscardPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable DiscardPolicyConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DiscardPolicy: { New: "new"; Old: "old" } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadonlyNew: "new"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Discard the new messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadonlyOld: "old"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Discard old messages to make room for the new ones

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/jetstream/variables/JetStreamApiCodes.html b/docs/jetstream/variables/JetStreamApiCodes.html index ea6b0615..e39143df 100644 --- a/docs/jetstream/variables/JetStreamApiCodes.html +++ b/docs/jetstream/variables/JetStreamApiCodes.html @@ -1 +1 @@ -JetStreamApiCodes | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable JetStreamApiCodesConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  JetStreamApiCodes: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ConsumerNotFound: 10014;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      JetStreamNotEnabledForAccount: 10039;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      NoMessageFound: 10037;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StreamNotFound: 10059;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StreamWrongLastSequence: 10071;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyConsumerNotFound: 10014
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyJetStreamNotEnabledForAccount: 10039
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyNoMessageFound: 10037
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyStreamNotFound: 10059
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyStreamWrongLastSequence: 10071

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +JetStreamApiCodes | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable JetStreamApiCodesConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    JetStreamApiCodes: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ConsumerNotFound: 10014;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        JetStreamNotEnabledForAccount: 10039;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        NoMessageFound: 10037;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StreamNotFound: 10059;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StreamWrongLastSequence: 10071;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadonlyConsumerNotFound: 10014
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadonlyJetStreamNotEnabledForAccount: 10039
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadonlyNoMessageFound: 10037
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadonlyStreamNotFound: 10059
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadonlyStreamWrongLastSequence: 10071

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/jetstream/variables/JsHeaders.html b/docs/jetstream/variables/JsHeaders.html index dcfa088d..00f37255 100644 --- a/docs/jetstream/variables/JsHeaders.html +++ b/docs/jetstream/variables/JsHeaders.html @@ -7,4 +7,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyPendingMessagesHdr: "Nats-Pending-Messages"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set on protocol messages to indicate pull request message count that was not honored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyRollupHdr: "Nats-Rollup"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyRollupValueAll: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyRollupValueSubject: "sub"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyStreamSourceHdr: "Nats-Stream-Source"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set if message is from a stream source - format is stream seq

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/jetstream/variables/PersistMode.html b/docs/jetstream/variables/PersistMode.html new file mode 100644 index 00000000..bb68ef6b --- /dev/null +++ b/docs/jetstream/variables/PersistMode.html @@ -0,0 +1,10 @@ +PersistMode | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable PersistModeConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PersistMode: { Async: string; Default: string } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Async: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Writes to the stream are committed, but writes to the disk are asynchronously synced. +The publish acknowledgement is sent before the sync to the disk is complete. +This could result in data-loss if the server crashes before the sync is completed, however +with an R3+ stream, the replication provides in-flight redundancy to reduce the likelihood of +this occurring with distinct fault domains. +This can significantly increase the publish throughput.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Default: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        All writes are committed and stream data is synced to disk before the publish +acknowledgement is sent. +This is the default mode, and provides the strongest data durability guarantee.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/jetstream/variables/PriorityPolicy.html b/docs/jetstream/variables/PriorityPolicy.html index e8136ddc..972ca431 100644 --- a/docs/jetstream/variables/PriorityPolicy.html +++ b/docs/jetstream/variables/PriorityPolicy.html @@ -1 +1 @@ -PriorityPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable PriorityPolicyConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PriorityPolicy: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None: "none";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Overflow: "overflow";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PinnedClient: "pinned_client";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyNone: "none"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyOverflow: "overflow"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyPinnedClient: "pinned_client"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +PriorityPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable PriorityPolicyConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PriorityPolicy: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              None: "none";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Overflow: "overflow";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PinnedClient: "pinned_client";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Prioritized: "prioritized";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyNone: "none"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyOverflow: "overflow"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyPinnedClient: "pinned_client"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyPrioritized: "prioritized"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/jetstream/variables/PubHeaders.html b/docs/jetstream/variables/PubHeaders.html new file mode 100644 index 00000000..2f735cd8 --- /dev/null +++ b/docs/jetstream/variables/PubHeaders.html @@ -0,0 +1,3 @@ +PubHeaders | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable PubHeadersConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PubHeaders: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ExpectedLastMsgIdHdr: "Nats-Expected-Last-Msg-Id";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ExpectedLastSeqHdr: "Nats-Expected-Last-Sequence";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ExpectedLastSubjectSequenceHdr: "Nats-Expected-Last-Subject-Sequence";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ExpectedLastSubjectSequenceSubjectHdr: "Nats-Expected-Last-Subject-Sequence-Subject";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ExpectedStreamHdr: "Nats-Expected-Stream";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                MessageTTL: "Nats-TTL";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                MsgIdHdr: "Nats-Msg-Id";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Schedule: "Nats-Schedule";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ScheduleSource: "Nats-Schedule-Source";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ScheduleTarget: "Nats-Schedule-Target";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ScheduleTTL: "Nats-Schedule-TTL";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyExpectedLastMsgIdHdr: "Nats-Expected-Last-Msg-Id"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyExpectedLastSeqHdr: "Nats-Expected-Last-Sequence"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyExpectedLastSubjectSequenceHdr: "Nats-Expected-Last-Subject-Sequence"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyExpectedLastSubjectSequenceSubjectHdr: "Nats-Expected-Last-Subject-Sequence-Subject"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyExpectedStreamHdr: "Nats-Expected-Stream"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyMessageTTL: "Nats-TTL"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the TTL for a message (Nanos value). Only have effect on streams that +enable StreamConfig.allow_msg_ttl.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyMsgIdHdr: "Nats-Msg-Id"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlySchedule: "Nats-Schedule"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyScheduleSource: "Nats-Schedule-Source"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyScheduleTarget: "Nats-Schedule-Target"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyScheduleTTL: "Nats-Schedule-TTL"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/jetstream/variables/ReplayPolicy.html b/docs/jetstream/variables/ReplayPolicy.html index 960e5caa..a353f521 100644 --- a/docs/jetstream/variables/ReplayPolicy.html +++ b/docs/jetstream/variables/ReplayPolicy.html @@ -1,3 +1,3 @@ ReplayPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable ReplayPolicyConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ReplayPolicy: { Instant: "instant"; Original: "original" } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadonlyInstant: "instant"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Replays messages as fast as possible

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadonlyOriginal: "original"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Replays messages following the original delay between messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/variables/RepublishHeaders.html b/docs/jetstream/variables/RepublishHeaders.html index ad0bb537..4359e45f 100644 --- a/docs/jetstream/variables/RepublishHeaders.html +++ b/docs/jetstream/variables/RepublishHeaders.html @@ -3,4 +3,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlySize: "Nats-Msg-Size"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The size in bytes of the message's body - Only if Republish#headers_only is set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlyStream: "Nats-Stream"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The source stream of the message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadonlySubject: "Nats-Subject"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The original subject of the message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/jetstream/variables/RetentionPolicy.html b/docs/jetstream/variables/RetentionPolicy.html index 9efa70be..1ca2cf2c 100644 --- a/docs/jetstream/variables/RetentionPolicy.html +++ b/docs/jetstream/variables/RetentionPolicy.html @@ -1,4 +1,4 @@ RetentionPolicy | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable RetentionPolicyConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                RetentionPolicy: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interest: "interest";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limits: "limits";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Workqueue: "workqueue";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadonlyInterest: "interest"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Retain messages while there is consumer interest on the particular subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadonlyLimits: "limits"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Retain messages until the limits are reached, then trigger the discard policy.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadonlyWorkqueue: "workqueue"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Retain messages until acknowledged

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/jetstream/variables/StorageType.html b/docs/jetstream/variables/StorageType.html index a243827c..7c57d58a 100644 --- a/docs/jetstream/variables/StorageType.html +++ b/docs/jetstream/variables/StorageType.html @@ -1,3 +1,3 @@ StorageType | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable StorageTypeConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  StorageType: { File: "file"; Memory: "memory" } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyFile: "file"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Store persistently on files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyMemory: "memory"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Store in server memory - doesn't survive server restarts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/jetstream/variables/StoreCompression.html b/docs/jetstream/variables/StoreCompression.html index fbfaf8fd..d16020b8 100644 --- a/docs/jetstream/variables/StoreCompression.html +++ b/docs/jetstream/variables/StoreCompression.html @@ -1,3 +1,3 @@ StoreCompression | @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/jetstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable StoreCompressionConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StoreCompression: { None: "none"; S2: "s2" } = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadonlyNone: "none"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      No compression

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadonlyS2: "s2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      S2 compression

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/kv/assets/hierarchy.js b/docs/kv/assets/hierarchy.js index 88636f05..fb85f0ad 100644 --- a/docs/kv/assets/hierarchy.js +++ b/docs/kv/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzwMKVNfWAgCbHgqm" \ No newline at end of file +window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzytWsqqurQUAmx4Kpg==" \ No newline at end of file diff --git a/docs/kv/assets/navigation.js b/docs/kv/assets/navigation.js index 78c95da4..d3814f0d 100644 --- a/docs/kv/assets/navigation.js +++ b/docs/kv/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJydlF1PwjAUhv9Lr4nARFQu+bgwGDGa4IXxonSHrKFrF3pKXIz/3UGNW+lKFy/3vn2e9TRp378IwieSCZkatgMkPVJQzKpvJqjWoPs2v8owF1W54zIlk2Fy9937I5eH3Meq8CKzrhEsiyOwdtcng/vb4U3i/GemUmAeaOOOtA7gOs7PQQDCqkCuZIvGqeO2hcR96VtOcZx+5DnHlk3YPM4Hp+i8/2eDQUndxT2vSNG0OGwe598osixwmHXX0fMgmTApBEy/bUdX8HSabcz1ovybcsz+O8+B7jndiMhM103VlGoYj5ZQnt2+rZHsNEPfXeGqxqOGKoUtNQLtk1KdgG6zeYsuCJ+UKvyLXbuavaf5+AEfV6Qu" \ No newline at end of file +window.navigationData = "eJydlM1OwzAQhN9lzxGloRTIscABBVEEUjkgDq69JVGdH8XriAjx7qgNEEeO44jrzM4X7zre108g/CCIYKX5HgkCKBklEAGXTClUs1Y/SSiTEMA+zQVE8/DyK/hLxnVmx+I6G81sugg15SGw6deHp1cX8/Ow953rQiC3gq08mA7a80AEAssKOSMUYCOVg6n8R7pBiYTrktIiH8D0bD/tNqeqsSlH2Z+OsXFM6NfxM+7TLKWBRlrdn3dOYvIMHlkjCyYcnZjuBJau3t2XY7pTWDRCosmcZ2KkBxit7s+/MOKJ40fpvImcu5xLLdBB+nEnspzTMV0f66mwV8NB+28/NatStpWens5M1IopXC7sx7TTOT/2MOtX9FHLhYESuGNaUrtD16X5sDqaVTQCfCiK0l5aHcv0LczbN+4W89o=" \ No newline at end of file diff --git a/docs/kv/assets/search.js b/docs/kv/assets/search.js index f1f80c85..59d13334 100644 --- a/docs/kv/assets/search.js +++ b/docs/kv/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1nG1z28YRx78L9VZ1iHvCwe+atJmmzqSZuHVeaDwaioQkWiTBEqASx+PvXhweiF3sAlhB6Zs4Ivb+e9j73d5hSdyXxSn7LV+8vfmyeNoeNou3kfLXi8Nqny7eLr49r5/SYnG9OJ925Z/r3SrP0/yb+uM3j8V+V15rPi2vL75etyo2UheVdXbIi9N5XWSnMakrbAdkrxfH1Sk9FF2POkfRUpmLp9vjKb3f/v5jehh11JjtKrM5fu4m43J1MZmjv8426XoiVrXFHPXN9pSux3t/MZmjn262xc9VhEd9BLNjazbHz+Mq/3W726xXp00+6qk0/A0YzvH1adzDp/m6+wnh/Uzl4/QIvCr65VRNV+Odv5jM0T/n6T9zAUal3af8VXfyvNptN6sifZd+HvXU2j1Vdq/x9D5dndaPUn95Zf0ir8qpyPRZmEqLM7KiWpputbi9O5ez7LvvxnNvZbR+Qe7CPjbpLi3Sf51+Pp8e0nFPtWl2Ojam8/xlf3uBx+zP8FkvHT+FP6ZXmENtNsfPenV4nxa/ror1Y3qadFda52nxW239Gq+7LJ/w1FjMUi8zTjEh35rM0S/n42pqHgWb+bOoXNdLiqZyQ231spyAvQROJ1w0JvP0y+SfTd1DazPHQ3qQxKm2mh+n+/NuV/qYnB3BrvTyinnxMLGhfHjJbhIpP27zcks9HqfOZo6H7WE73vnGYK72tlwJ/0jrzUA6vhPrzI+d+Ry/n/b/zqrc+PdDMRG8T/siqxNjYzrHX0nP+J01BnO0j5NL12vWq6rt9KNi7eOlz0XUU70ej8eqMtxcDOf5mrqbuXdxSvfZ8/hwXEzm6OcludPQ5iW0r+E1L1bFeXwULiaz9M93n8pn0O+zkwCtxvg+O72Kr87n1LrSOZy/tpyPm6m9ysVkjn6VkkblW4tZu9Tw0ej+tDb4v+7i/qJe8CQGClvvnumTa/nZn1LSanVE9azQEXnJ4SI9Um/AipKwdh0e3xmPKO/K7cOwbnP1xarZkdlpX1SbqzLVJI5sN3zvPlxki8/HIPphdOhJ++fvUIWuEak/nVAiW/0RlauLxdBd1v0Y3SKP6V8s5PpsJHLeST4aC0T7E0i4jMbVWJq9dGK47HIeCEN+KbWcJ8OQj8ahKRMci2057YkzdFUelXIP+7zNzvn79L8CyavWPK/Mh24G93TsnvAuonVcfSq/h16xnKpM1crbfgwVy6ustRlz0JnM8lBuJIvVmH5rMEudIx9oj4M/qrxLDw/F45j4xWKWfpmBT6tA0ZgLaDTLS2A6n3ACbGb54DMEcDCVIPrq+FEyH+99c32WdrnD2B4extQvFnL9fh74cbvfFjSp1R/LM8E625cZKmcHE2hdYbuhbjedGpyz+fq0PbJ0Ql/Ybp6vfoGF8zNVYJnysV/9fnv3GT73cl6g1Ww/HwLr77d/0AnRc1VNirw2nOltezqBLTTrpzWZ5+G4W63TfbAdcwKt5vk5pcfddr0aHx5gNNvL+a7cTtOk3nNzsZrnJ8/Op/UEa53NTB/lfFg9jEPW2czzURS7Uf36ulibZsah/Z5kp0fVfj4XQ4LdpT9n99jTE24dQQeHIr7dp9mZzra+v87uRb5ozN7jOlTrr/74hfFn6r2tXndpjuYPh/XuzDyKwYtzdIdogRflvDymq016ym+zw24gAGgIe+ZD44g6OuB5+3DITqSyO+y6tp8q8Ap9j40N9nqxfI0/br9PfY1v+yV+yh3UeZ9+f8r2vwztoKnbutF92UiwpR7oRZ/VXzJSbwkfyeskD+Tx8dJ+9GuxyrHwS7G+7tR+bUwbfZXTFx79GmdMNecSXac7UWwfU8aF4r7weJG4p6snU9/z6rRd3e1elv4Q2H/d7f7RG71R0avVbje9/UbNbm9DFIY68OMqLz6gJ8Zx/6XHYuoB8gXu/1N9KZD/C2bp8Q7UXyPkkkQ92AXXdeDbVZ468y79jKug9+fDusoF32CD0ZF18JHtfnXeFXXhvkwrOaNMbKTiP2XZkRQrO114mZP8eF2uE5v098XbL4vnctELifHtQr3Rb5LS8n6b7jbhR7SL9gcA2b55mthk63P1vx8bsw9p+EIgGNfW3ywX1zfLa23eeG0+fry+aRtXF6oPWo3uk6phVP4VXWv/JkoS1DAiDSPUUJV/qWuj3+hljBoq0lChhnqoq5o01KihKf/SnEdDGhrU0JZ/Ga6hJQ0taujKvyzX0JGGDjWMy78c1zAmDWPU0Jd/xdxweNLQo4YlQTee85iQhgkGIPCQcC0jyk7Ug6eiZ8k2ZvjBAEUBiyhiG1OGIgxRFNCIWP4iylGEQYoCHhGLUkRZijBMUUAkYnGKKE8RBioKmEQsUhFlKsJQRQGViMUqolxFGKwo4BLFbGPKVoThigIyEYtXRPmKMGAqMBOxhClKmMKEqcCMYglTlDDVS1FVjoq4XKOYLIUJU4EZxWc4SpjChKnAjGIJU5QwhQlTgRnFEqYoYQoTpgIziiVMUcIUJkwFZhRLmKKEKUyYCswoljBFCVOYMBWYUZ7LfIoSpjBhOjCjEnZNoYRpTJgOzGiWME0J05gwHZjRbA7TlDDdWwgDM5olTDNrISZMV6uh5gKmKWEaE6YDM5olTFPCNCZMB2Y0S5imhGlMmA7MaJYwTQnTmDAdmNEsYZoSpjFhOjCj2RymKWEaE2YCM5rNYYYSZjBhJjBjltxQGUqYwYSZwIxhCTOUMIMJM4EZwxJmKGGmt90KzBh+w8XsuDBhptpzGfaeKWEGE2YCM4YlzFDCDCbMxINJ31DCDCbMBGYMi6ehhBlMmKlWSfaWKWAGA2aXQxs/S/mymC8bDd6xpXxZzJet+GLnlKV8WcyXrfhi55SlfFnMl634YueUpXzZ3pY+EGPZrG2ZXT3my1b7enZOWcqXxXzZQIxl55SlfFnMlw3EWHZOWcqXxXzZgIw17DhTwCwGzAVmrOUIc5QwhwlzgRnLTgtHCXOYMBeYsSzbjhLmMGEuMGNZwhwlzGHCXGCGfdR0FDCHAXMVYCydjgLmes+NARnH0umYR0cMmIsHh9lRwBwGzAVkHIu2o4A5DJgLyDgWbUcBcxiwOCDjWLRjCliMAYujQTpjCliMAYsDMo7dzcQUsBgDFgdkHLvWxBSwGAMWB2Yc/6BPCYsxYXFgxrGZN6aExZiwuCKMnRcxJSzuVSeqJZLdL8dMgQITFleEsRMjpoTFmLA4MBOzEyOmhMWYMF+tkSzbnhLmMWE+MBOzbHtKmMeE+cBMzLLtKWEeE+YDMzGLp6eEeUyYD8zELJ6eEuYxYT4wE7N4ekqYx4T5wEzM4ukpYR4T5gMzMYunp4T5Xg2sKoKxhHmmDIYJ88ngauMpYR4TlgRmPItnQglLMGFJYMazeCaUsAQTlgRmPItnQglLMGFJYMazz4IJJSzBhCWBGc/imVDCEkxYEpjxLJ4JJSzBhCWBGc/imVDCEkxYEpjxLJ4JJSzBhCV+cIlNKGFJr9JalVr5WitTbO1XWyvEBuqtXMG1V3FdVpt9tlBSX+u37xVdl2ow99fX+u17dddlVbRgWauv9dv3Sq/LatfPPgzX1/rte9XX5fCDZX2t375XgF26wblSX+u379Vgl4GkhC95L5kq7LJXhl0GmBK+6r1kCrHLXiV2GXhK+ML3kqnFLnv81eV+vvbNFfxJxT/wlPDlb7bm3+OvquMnfAWcK/s3n1VfnT2npyLd/FB/hXZzs+iOAfiyuG2+WYts+23dl0Xkyv9+/dp9k1b+Bb5MC9eCs/47/kDMAbFYKNZ/fR/IxUDOy+TAeQqdkOp0lEgGfnndyZQYd/1Zyu7vrvpW9in93BweA9Q0UCuxEalVr3d1GgaMnpGNXvu7/04E3NWybqTrf8pHPLli/SUsGDwPbi8RCTGnHQC9BAyiLFrNmQaAA3CrKpJp9IcNjJosPOiH1Z2OA3CXDysyJfBuG4gMCHTd0gjj3bx6BgIEtJRqxOL6XysMWPvaR6dqwdA52a1ejnMAfYOzWMtUmje5QFfADVrZhAGnPoDOAAyUjIPmVxT1bMmqX1qAZGBgMpBFuj0rAvQKqChhoOu3aACXYI44aYTAz/mBEsgAsVipPp0C3BNIcUqo0hykBfIkGHWRBDwnC9ADQiOTORAAAcVWtoSA4zRAWMBSq2Q66LgMoAQSkZKtsg94AVFgoFVStwkbaYkUPiYMwAPYkQmhH8Z2Qh4MWiIbfGbpVyCF6WaVjOP2VmWbit7vZ0EXwc0mMrAuv4oFKmAcE1nM6hNCwNoG5r6WjR939AcQBOlWy6LUP9cDiIGpo2ULwCfUGxAg36xpso1EdSAciDQItLB9LzOCfBTLwtKb/hZmtGbKuYbHRDaJ69/EgvCCJU2bFm1ZnJ+eUbYFk8XKFsenZ7LRsgBGK5u4jQq6LQtuywoj89w8krQ/9AdqYKo62Qx5eiYkW0CQk0Z417wPCDCCSVIaZ0SyAQpGGhwmLDG4IS/LPU/Px3PBSQF4vLRL7e+wwRwFmSeRDhSfdzzIO4lwttZSXJYGOCa6nWWypN+oMkHzIB0kMhLA76PBNhQ+Syxl0W9fZwZcAhUnFKlOqwBgglxtZTEHr2GCrgCaYllX8DuWAEyQj2JZ3m9fowQiIDRetvgcsuzIJbYEVm4iWYzq4ztAmMG8tbJEBF4tB2EGU8TJYgPe/gThATpeNmvpLj2BDL9Ao/e8GcFHMtn6g97nA+kewOyap2ovjFK/JqZBr7SwV/AIMKAE+NGyBIRP+AJSYBnRsvRfneQFFECItGyetsd1ARFAs5bFt3s5GEAIUrSXzSvw8i/QAUPlZZOLexMMZHm48ZTeH5Vx4P5i2QQ5ZXiH59Eck2mAs8/AkAEhI9RpX4EGkQYoe9nyR3cMBuR3E7Urs1SteWUa9AnMCS+bqO3RzSAHwYqzLB+2J0+A8QbRiWUc0qPdQJzAEmZk06N3cBvQAvneyLp2eYcZ0AiilMggqt5BB4MFHw1lubA9JQ7cDCwNy7hB74iBFUzB6SWb6ehIbkAQ3NHJRgsduQ2UYKdkY8Ucpg304PcfsnCR/aqFFbm2LCObJ80blmD4QLo2tp3/gpn78Xpx3B7T3fZQtr35+PXr/wB+nzoE"; \ No newline at end of file +window.searchData = "eJy1nd+T27YRx/8X+lV1CIAggXtr0maa2pNkYtd5uPF4aIm+k48SVZI65+Lx/94Bf4i73CUJ8dInJ9Liu+DigwW4FHFfg7L4UgU3t1+Dh/1xF9wIaTbBMT1kwU3w/Xn7kNXBJjiXeXATbPO0qrLqu/bjl/f1IQ82/afBTRB82/QqWsiLyrY4VnV53tZFOSf1AtsB2U1wSsvsWA89GhyJUEYXTx9OZfZp/8fr7DjrqDPLG7M1fj4uxuXFxWSN/rbYZduFWLUWa9R3+zLbzvf+YrJGP9vt61+bCM/6cGan3myNn/u0+n2f77ZpuatmPd2n1RdguMbX53kPn9frHhaEDyuVT8sj8KzoV3WZpfOdv5is0T9X2b8rD4zOVfa5etaVPKb5fpfW2avsadZTb/fQ2D3H05ssLbf3vv6qxvoqrzKWIhqzsJQWV2RFGUbDavHh43mf7374YT73NkbbK3IX9rHL8qzOfil/PZd32byn1rQoT53pOn/FP67wWPwlPk/n+ezcGazRbpeln93/LK9ex9ZsjZ9tenyT1b+n9fY+KxfdbdNjldVfWuvneM2LasFTZ7FKvczSekG+N1mjv0vrdGmOOpv1M3SXuX3DUt5pra7LN9iLmwMLLjqTdfpVXRZL19DbrPGQHX3i1Fqtj9Onc56/yp4WZ4eze8ienjEv7hY2q3fX7FSR8v2+qotyPk6DzRoP++N+vvOdwVrtfZrv/8zajUY2v8sbzE+D+Rq/nw9viyY3/vNYLwTv86Eu2sTYma7x95A9zV9ZZ7BG+7S4LD5nLWzaLt+Gtj6uveeintq1fj5WjeHuYrjO19LVrL2KMjsUj/PDcTFZo18d3hbL0FaHungOr1Wd1uf5UbiYrNI/f/ycbesfi9IDrc74U1E+i6/B59K6Mjhcv7acT7ulvcrFZI1+k5Jm5XuLVbtU99Hs/rQ1+L/u4v4mr7jLA0WzV4/0rvjV4+EvKZf1Ol61MtcR/3LGRXqmloEVfcI6dHh+ZzyjnO8rOkEvut23V6sWJ2anfVHtvvVTtYnQw/C9eneRrZ9OTvTd7NCT9o8/oOpfJ9J+uqBEtvozKi8uFlNX2fZjdos8p3+x8NdnI1HxTqrZWCDaH0DCZTRezKXZSyemSzrniTBUlzLOeTEM1WwcuhLEqd4XRxoO9K1/VE5l9rgvztWb7L8eki9686oxn7oY3NO5a8K7iN5x86n/NYwK8VRlqQ7f92OqEN9krd2cg8FklYddltfpnH5vsEqdIx9oz4M/q5xnx7v6fk78YrFKvzhlZeoomnMBjVZ5KdMvr+ZDVKZfnhElN2eqhYsANqt88BkIOFhKQGN1fKtazfe++36VdlWX++PdnPrFwl9/nGdeZU/8gtp/8ew1FQktL6uXDl23smIvi4sr62Ucm9f7w76mC0r7sX8W3haHU5lVLOhA6wW2m+p516nJfFlty/2JzQzQF7Zb52tc3OL8LBW3lnwc0vIhK9++fT3rpbWq6/wZfv748PEJ1jZ4P4PVaj/vXL55s/+TMjxy1SSmqjVc6W1fluA2ifXTm6zzcMrTbXZwtnNOoNU6P2V2yvfbdH54gNFqL+eP+b6iC/fIzcVqnZ+qOJfbBdYGm5U+6qJM7+YhG2zW+Whn3LT+lTOSZuCpPb3Pbp6q/Zo+5UW649c7+OWz1zwitrzuoc5dt/ZRb4vr36Q3EjNXzp0aBvjltWNxrqdV67/0bm2k53mrBjo4Rf/+kBVnmvnG/ga7q3zRmL3Bdd/eX/vxlfFnnq/0esNXazR/Om7zMwMp/HKN7hQt8Et/Xu6zdJeV1YfimE8EAA3hyHxqHFFHJzzv745FSZ6kTLtu7ZceqHj6nhsb7PVi+Rx/3P019TV/A+njp8yq8yH7sSwOv03dUVK3baNPZXHwuMWc6MWY1d8KUt90H/mvJ3ekXHNpP/sYunHs+RB6rLu0R5/TRo9Ox8Kzj03nVCsu0Q26Cw+35pTxg5mx8PxDmZGuWkx9j2m5Tz/m16U/BPbf8/xfo9GbFX2R5vnyLRdq9uGDi8JUB16nVf0OVVDm/edpVS8VVK5w/5/mIVz1C8zS8x1oH9tVPol6sgvx0IHv0yqLI1Ik+XQ+bptc8B02mB3ZGN6mf0rPed0+KPvlBIoMgzKx8RX/uShO5OHAoAu/5iTfb4L9cZf9Edx8DR6zskmMN4F8qV7aYBN82mf5zv0gPuh/cFMcuju7XbE9N//5vjN7l7kHcM64tf4uDDa34Ubpl3Gi37/f3PaNmy+aD3qN4ZOmoQg2t2Kj7MswQu0EaSdQOxlsbuUmil6KyKCGkjSUqKGa6qkiDRVqGAWbW8V5jEjDCDXUweY24hpq0lCjhnGwudVcw5g0jFHDJNjcxlzDhDRMUEMTbG4TZjQMaWdQOxtsbg3n0JKGFg+/o8FyLQUlR4zQadgJ2cYMPpgf4agQgm1MERKYIeHIECx+gmIkMEfC0SFYkgRFSWCWhCNEsDQJipPAPAlHiWCJEhQpgZkSjhTBUiUoVgJzJRwuImEbU7YEhks4ZASLl6B8CQyYdMwIljBJCZOYMOmYkSxhkhImRxmqSVEsYZJJUpgw6ZiRkstTkhImMWHSMSNZwiQlTGLCpGNGsoRJSpjEhEnHjGQJk5QwiQmTjhnJEiYpYRITJh0zkiVMUsIkJkw6ZiRLmKSESUyYcsxIy2RNRQFTGDDlkFH8ckQBUxgw5ZBRLGCKAqZGy6BDRrEpTDErIQZMNWshC5iigCkMmHLIqIiLF+VLYb6UI0axfCnKl8J8KUeMYvlSlC+F+VKOGMXypShfCvOlHDGK5UtRvhTmK3LIKDaDRRSwCAMWOWQiNoNFFLAIAxY5ZCJudxZRviLMV+SIiVi+IspXNNpqOWIifrPF7LYwX1Gz32ITWEQBizBgkUMm0twlU74izFfkiIlYviLKV4T5isxkwo8oXxHmK3LERCycEeUrwnzpcGILrildGtOlxcR+UVO2NGZLy8nr1RQujeHSDVzsfNIULo3h0g1c7HzSFC492ss7XDQ7nzSzncdw6WZDzyZsTenSmC7teNF8wChdGtOlHS9asY0pXRrTpR0vmr+DoXRpTFfsiNGa8xxTvmLMV+yY0TEDWEwBizFgsUNGs3MipoDFGLDYIaMN55jyFWO+YkeMZvmKKV8x5ivWU7enMcUrHt0uOmBils2YuWPEeMXNPSPLZkzxijFesZkeZIpXjPGKHTAxu1LEFK8Y45U4YGJ2pUgoXgnGK3HExCzYCeUrwXwljpiY3YoklK8E85WoKbATyleC+UocMTF/e0/5SjBfiUMmZmdFQgFLMGBJAxibdhMKWDKqSUznr4QpS2DAkun8lVDAEgxY0gDGTsiEApZgwIxDJmEnlaGAGQyYadZHdlIZCpjBgBk5eW9gKGAGA2YcMwk7qQwlzGDCjGMmYSeVoYQZTJhxzCTspDKUMIMJM46ZhJ1UhhJmMGHGMZOwE8NQwsyo8tWUvtiJYZjqFybMOGYSdmIYSpjBhNmGMBZPSwmzmDDrmDEsnpYSZjFh1jFjWDwtJcxiwqxjxrCEWUqYxYRZx4xhCbOUMIsJs3oyk1hKmMWE2Xgyk1hKmMWEWceMYdm2lDCLCbOOGcOybSlhdlRgtVMbEsuUWMc1VseM4Ut3IVdmHdVZwwYyvnoXMpXWcFRqDRvO+AJeyBRbw1G1NWxQ4yos7Vfj5qN6a+jwsXydOGQqruGo5Bo6gixfKg6Zoms4qrqGDiLLV4tDpu4ajgqvoePI8gXjkCm9hqPaazi9O2u/G7cflV9Dh5Pla84hU4ANR/i1NX6+7MxV+UmZX0wV2ARb5x/RJ6bXUcGV+se1/qZ8z9arBFfsH1f7mwI+W0QRXLl/XO9vSvhsQUJwBf9xxb8p4vNThyv5j2v+TRnf8pmDq/qPy/5NJd/ymYMr/I8r/00x3/KZg6v9j4r/oqnnW/75ElP+F6P6v5DtIyY+dzCPAMToGYBoyvoinHjOxD1oaj9rHtU+ZmWd7X5qH9ne3gbDETJfgw/dk1yh+6fDXwMRBzdfv30bntzefP0GHt6675yz8fkwQCwGYomn2PjoFyCXADnjJwfO4hmE5KAjPWXcr/JATwzoifWSgL+3GIQsjJBniD42PyR4yJ66s8uAmgVqMvRTa94AHjQi0KPIs0Pdq2GDSDhohG0j1f4T6ysUGwkYdXB5nlfHHIgDMADdlMJPrz32BmgIoOEHExk2BSLuqQDe/xh0EnA9xjM+8PVnEGnAUdtSe+p1byeDAMHJ1lEQmU7UM2D9m4GDagwuNfZLU5cTf0DfQOSlX+j7X2cPIhpcoE7aZkn3r/XDHRwUBDoXgc756jQ/BGpnT9H8WAiMaRjC7ODHe3++EOgWWCCkZ+TbNy/B6AG+Yr8cg15DAsgDJeN7Sd2JRuCaQM6Tnv3pDnYEiRNg4CUBz20EOIHQ+MkcCZEAa91NtaT7114jOiYSrL/Sb/1FRy4BJbB+Sr/18w6vMBKsBapbY9xW3UcKH2MJsBwk/SDAP/YG6zDMn6EfDczmQIEJq7o8bGR/rX65c/SjcNBHCfvoR8Xlt95ARkEZv7C1B02B6wThUp6XxZwgBQTBtSnlJTg+HgqIgStUfovEZ9QbMGv6dc+P0+bM0kEHzBm/KdO+Ugz4hoD7XckoA2iYnbpZF3cX5e7zPSXxYIHEqXRPt9+oPTyi3oH5ov1m3cMj2Y1pQKP2mxedCrosDdcDv/F6eOxuffoXWIAagCj2myIPjwRlDZJm7AnAI3ejEQMWE98Y5d1L0kAG9CfxjRGaExGIS+SrwMTXgIxhfdk7ta/GkegYkDGsb5ibu12uZ4Aj65dfnVjNSYHZaz0n62P/CgWQgbfhoV8qe3jkk6uBN9KhL9iNFrMYGXj/G6o+l/gC2sgycbNw4xz6DSh4vQEIwch5VjD60z/ArAGsxn7Mt4c7gWkDwq79cAdvzoOlDXTF+Opc3owHOmDGGL8A49fegRSYL8ZvEejfbAciYKYYP3yORXHi1gFXrAO3XX6It8dmgfECYGu/+IAjXQA6IM6J3x09eCMfxAfsJIxfUqJ3OmiyXqExuokXYMCF34Cj93rB8ghmRdxlD+s3wUitUgGClB9B6OhNoARirTxjjU7WBFIg/yi/9DMqfCoQIuUXmv7gH0AhGLHEb/3oz9oEPQH4RH74DKc+AJLh7twvJOBUB6ADAmM8A8O8VgpmB8Q69FWkOjEAMfHLPmWB99UWPhPwnKrg5FKQxsBCGvkN/OVwCxBqMPLWszdkExOBrBxd7qn9UuvlMAyw8wBXZj2vrPujDnCpgHH2FWnOdQLjDYBO/NIhPZgVxAms8JHfCj86dhVowUK3X6gvJyKAUMNHJqHf+I+2LQYMvvWbE/0hr+BqwASN/AKNXjkF8wtugj0fJ6G/1gEQQpsNLyX01ziAEqwP+Q0883c2gB4sFPkNPtk/azD0cVcQS/z61r2wDYYPJLUo7hOAxzi+3wSn/SnL98csuLl9/+3b/wDddsbu"; \ No newline at end of file diff --git a/docs/kv/classes/Bucket.html b/docs/kv/classes/Bucket.html index ce0f78db..724ecd42 100644 --- a/docs/kv/classes/Bucket.html +++ b/docs/kv/classes/Bucket.html @@ -1,4 +1,4 @@ -Bucket | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +Bucket | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _prefixLen bucket codec @@ -16,6 +16,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _buildCC _deleteOrPurge _doDeleteOrPurge +_put bucketName canSetWatcherName close @@ -45,36 +46,41 @@ watch bind create -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • bucket: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • js: JetStreamClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • jsm: JetStreamManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _prefixLen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _prefixLen: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bucket: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        codec: KvCodecs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        direct: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        editPrefix: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasWildcards: (k: string) => boolean = hasWildcards
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        js: JetStreamClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        jsm: JetStreamManager
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prefix: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stream: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useJsPrefix: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        validateKey: (k: string) => void = validateKey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        validateSearchKey: (k: string) => void = validateSearchKey

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • get prefixLen(): number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _buildCC

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • _buildCC(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              k: string | string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              content: KvWatchInclude,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opts?: Partial<ConsumerConfig>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Partial<ConsumerConfig>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • content: KvWatchInclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • opts: Partial<ConsumerConfig> = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Partial<ConsumerConfig>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _deleteOrPurge

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • _deleteOrPurge(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              op: "DEL" | "PURGE",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opts?: Partial<KvDeleteOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _doDeleteOrPurge

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • _doDeleteOrPurge(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              op: "DEL" | "PURGE",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opts?: Partial<KvDeleteOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Creates a new entry ensuring that the entry does not exist (or +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • bucket: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • js: JetStreamClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • jsm: JetStreamManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _prefixLen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _prefixLen: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bucket: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        codec: KvCodecs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        direct: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        editPrefix: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasWildcards: (k: string) => boolean = hasWildcards
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        js: JetStreamClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        jsm: JetStreamManager
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prefix: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stream: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useJsPrefix: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        validateKey: (k: string) => void = validateKey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        validateSearchKey: (k: string) => void = validateSearchKey

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • get prefixLen(): number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _buildCC

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • _buildCC(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              k: string | string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              content: KvWatchInclude,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opts?: Partial<ConsumerConfig>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Partial<ConsumerConfig>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • content: KvWatchInclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • opts: Partial<ConsumerConfig> = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Partial<ConsumerConfig>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _deleteOrPurge

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • _deleteOrPurge(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              op: "DEL" | "PURGE",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opts?: Partial<KvDeleteOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _doDeleteOrPurge

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • _doDeleteOrPurge(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              op: "DEL" | "PURGE",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opts?: Partial<KvDeleteOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _put

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • _put(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              data: Payload,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opts?: Partial<KvPutOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              markerTTL?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • data: Payload
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • opts: Partial<KvPutOptions> = {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OptionalmarkerTTL: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Creates a new entry ensuring that the entry does not exist (or the current version is deleted or the key is purged) If the entry already exists, this operation fails.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • data: Payload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • data: Uint8Array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalh: MsgHdrs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ekey: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Deletes the entry stored under the specified key. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          markerTTL is specified as a Go duration strings +("10s", "1m", "1h"...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • data: Payload
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OptionalmarkerTTL: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            duration is specified as a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • data: Uint8Array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalh: MsgHdrs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ekey: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Deletes the entry stored under the specified key. Deletes are soft-deletes. The server will add a new entry marked by a "DEL" operation. Note that if the KV was created with an underlying limit (such as a TTL on keys) it is possible for a key or the soft delete marker to be removed without additional notification on a watch.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Destroys the underlying stream used by the KV. This +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Destroys the underlying stream used by the KV. This effectively deletes all data stored under the KV.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • key: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns the KvEntry stored under the key if it exists or null if not. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • key: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns the KvEntry stored under the key if it exists or null if not. Note that the entry returned could be marked with a "DEL" or "PURGE" operation which signifies the server stored the value, but it is now deleted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalopts: { revision: number }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<KvEntry>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns an iterator of the specified key's history (or all keys). +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalopts: { revision: number }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<KvEntry>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns an iterator of the specified key's history (or all keys). Note you can specify multiple keys if running on server 2.10.x or better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • opts: { headers_only?: boolean; key?: string | string[] } = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<QueuedIterator<KvWatchEntry>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • info: StreamInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • jm: JsMsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • isUpdate: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns KvWatchEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns an iterator of all the keys optionally matching +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • opts: { headers_only?: boolean; key?: string | string[] } = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<QueuedIterator<KvWatchEntry>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • info: StreamInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • jm: JsMsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • isUpdate: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns KvWatchEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns an iterator of all the keys optionally matching the specified filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string | string[] = ">"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<QueuedIterator<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Deletes and purges the specified key and any value +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string | string[] = ">"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<QueuedIterator<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Deletes and purges the specified key and any value history.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalopts: PurgeOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<PurgeResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • olderMillis: number = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<PurgeResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Sets or updates the value stored under the specified key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sm: StoredMsg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns KvEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns information about the Kv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<KvStatus>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • edit: boolean = false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Updates the existing entry provided that the previous sequence +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalopts: PurgeOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<PurgeResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • olderMillis: number = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<PurgeResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Sets or updates the value stored under the specified key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sm: StoredMsg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns KvEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns information about the Kv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<KvStatus>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • edit: boolean = false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Updates the existing entry provided that the previous sequence for the Kv is at the specified version. This ensures that the KV has not been modified prior to the update.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • data: Payload
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • version: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionaltimeout: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            in millis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns an iterator that will yield KvEntry updates as they happen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<QueuedIterator<KvWatchEntry>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • js: JetStreamClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • opts: Partial<KvOptions> = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<KV>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Creates a new entry ensuring that the entry does not exist (or +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns an iterator that will yield KvEntry updates as they happen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<QueuedIterator<KvWatchEntry>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • js: JetStreamClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • opts: Partial<KvOptions> = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<KV>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Creates a new entry ensuring that the entry does not exist (or the current version is deleted or the key is purged) If the entry already exists, this operation fails.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • js: JetStreamClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • opts: Partial<KvOptions> = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<KV>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        markerTTL is specified as a Go duration strings +("10s", "1m", "1h"...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • js: JetStreamClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • opts: Partial<KvOptions> = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<KV>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/kv/classes/Kvm.html b/docs/kv/classes/Kvm.html index c00b09e5..6e64e853 100644 --- a/docs/kv/classes/Kvm.html +++ b/docs/kv/classes/Kvm.html @@ -1,5 +1,5 @@ Kvm | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class Kvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The entry point to creating new KV instances.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          js

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          create list @@ -7,7 +7,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Creates an instance of the Kv that allows you to create and access KV stores. Note that if the argument is a NatsConnection, default JetStream Options are used. If you want to set some options, please provide a JetStreamClient instead.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • nc: NatsConnection | JetStreamClient

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Kvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          js: JetStreamClientImpl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Creates and opens the specified KV. If the KV already exists, it opens the existing KV.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<KV>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Lists all available KVs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Lister<KvStatus>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Open to the specified KV. If the KV doesn't exist, this API will fail.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<KV>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • nc: NatsConnection | JetStreamClient

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Kvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          js: JetStreamClientImpl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Creates and opens the specified KV. If the KV already exists, it opens the existing KV.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<KV>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Lists all available KVs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Lister<KvStatus>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Open to the specified KV. If the KV doesn't exist, this API will fail on accessing +the KV.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<KV>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/kv/functions/Base64KeyCodec.html b/docs/kv/functions/Base64KeyCodec.html index b22a95a0..0bb06f03 100644 --- a/docs/kv/functions/Base64KeyCodec.html +++ b/docs/kv/functions/Base64KeyCodec.html @@ -1 +1 @@ -Base64KeyCodec | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function Base64KeyCodec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns KvCodec<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +Base64KeyCodec | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function Base64KeyCodec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/kv/functions/NoopKvCodecs.html b/docs/kv/functions/NoopKvCodecs.html index 9d07225c..1ebdd0d1 100644 --- a/docs/kv/functions/NoopKvCodecs.html +++ b/docs/kv/functions/NoopKvCodecs.html @@ -1 +1 @@ -NoopKvCodecs | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function NoopKvCodecs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +NoopKvCodecs | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function NoopKvCodecs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/kv/functions/defaultBucketOpts.html b/docs/kv/functions/defaultBucketOpts.html index 82ce5397..18b16b67 100644 --- a/docs/kv/functions/defaultBucketOpts.html +++ b/docs/kv/functions/defaultBucketOpts.html @@ -1 +1 @@ -defaultBucketOpts | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function defaultBucketOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +defaultBucketOpts | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function defaultBucketOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/kv/index.html b/docs/kv/index.html index 6ac29731..fd12d880 100644 --- a/docs/kv/index.html +++ b/docs/kv/index.html @@ -1,5 +1,5 @@ @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/kv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        License -jetstream +kv JSDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        JSR JSR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -49,7 +49,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/kv/modules.html b/docs/kv/modules.html index 5001a36e..d9fe5576 100644 --- a/docs/kv/modules.html +++ b/docs/kv/modules.html @@ -1 +1 @@ -@nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/kv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Bucket
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Kvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KV
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvCodec
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvCodecs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvDeleteOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvEntry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvLimits
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvPutOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvWatchEntry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvWatchInclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvWatchOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            RoKV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvWatchInclude

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Base64KeyCodec
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            defaultBucketOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            NoopKvCodecs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Functions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +@nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/kv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Bucket
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Kvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KV
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvCodec
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvCodecs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvDeleteOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvEntry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvKeyCodec
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvLimits
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvPayloadCodec
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvPurgeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvPutOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvWatchEntry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvWatchInclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvWatchOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                RoKV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                KvWatchInclude

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Base64KeyCodec
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                defaultBucketOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                NoopKvCodecs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Functions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/kv/types/KV.html b/docs/kv/types/KV.html index f013bd61..a60d50f6 100644 --- a/docs/kv/types/KV.html +++ b/docs/kv/types/KV.html @@ -1,20 +1,23 @@ -KV | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  KV: RoKV & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      create(k: string, data: Payload): Promise<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      delete(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      destroy(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      purge(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      put(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          data: Payload,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          opts?: Partial<KvPutOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      update(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          data: Payload,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          version: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          timeout?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • create: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • create(k: string, data: Payload): Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Creates a new entry ensuring that the entry does not exist (or +KV | @nats-io/kv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        KV: RoKV & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            create(k: string, data: Payload, markerTTL?: string): Promise<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            delete(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            destroy(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            purge(k: string, opts?: Partial<KvPurgeOptions>): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            put(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                data: Payload,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                opts?: Partial<KvPutOptions>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            update(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                data: Payload,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                version: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timeout?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • create: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • create(k: string, data: Payload, markerTTL?: string): Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Creates a new entry ensuring that the entry does not exist (or the current version is deleted or the key is purged) If the entry already exists, this operation fails.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • data: Payload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • delete: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • delete(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deletes the entry stored under the specified key. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            markerTTL is specified as a Go duration strings +("10s", "1m", "1h"...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • data: Payload
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalmarkerTTL: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              duration is specified as a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • delete: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • delete(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deletes the entry stored under the specified key. Deletes are soft-deletes. The server will add a new entry marked by a "DEL" operation. Note that if the KV was created with an underlying limit (such as a TTL on keys) it is possible for a key or the soft delete marker to be removed without additional notification on a watch.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • destroy: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • destroy(): Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Destroys the underlying stream used by the KV. This +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • destroy: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • destroy(): Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Destroys the underlying stream used by the KV. This effectively deletes all data stored under the KV.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • purge: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • purge(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deletes and purges the specified key and any value +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • purge: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • purge(k: string, opts?: Partial<KvPurgeOptions>): Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deletes and purges the specified key and any value history.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • put: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • put(k: string, data: Payload, opts?: Partial<KvPutOptions>): Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets or updates the value stored under the specified key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • update: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • update(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                data: Payload,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                version: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timeout?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Updates the existing entry provided that the previous sequence +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • put: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • put(k: string, data: Payload, opts?: Partial<KvPutOptions>): Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets or updates the value stored under the specified key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • update: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • update(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                k: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                data: Payload,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                version: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timeout?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Updates the existing entry provided that the previous sequence for the Kv is at the specified version. This ensures that the KV has not been modified prior to the update.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • data: Payload
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • version: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionaltimeout: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              in millis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/kv/types/KvCodec.html b/docs/kv/types/KvCodec.html index d819d162..9652f47f 100644 --- a/docs/kv/types/KvCodec.html +++ b/docs/kv/types/KvCodec.html @@ -1,5 +1,3 @@ -KvCodec | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias KvCodec<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Generic type for encoding and decoding values -before they are stored or returned to the client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type KvCodec<T> = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          decode(k: T): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encode(k: T): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      decode -encode -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +KvCodec | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias KvCodec<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type KvCodec<T> = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            decode(k: T): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            encode(k: T): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        decode +encode +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/kv/types/KvCodecs.html b/docs/kv/types/KvCodecs.html index c928edcc..b1ee0ed9 100644 --- a/docs/kv/types/KvCodecs.html +++ b/docs/kv/types/KvCodecs.html @@ -1,5 +1,8 @@ -KvCodecs | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias KvCodecs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type KvCodecs = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              key: KvCodec<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              value: KvCodec<Uint8Array>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          key +KvCodecs | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias KvCodecs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A KvCodecs object contains two codecs: one for keys and one for values. +These codecs are used to encode and decode keys and values before they are stored +or retrieved from the KV.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type KvCodecs = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                key: KvKeyCodec;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: KvPayloadCodec;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            key value -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            key: KvCodec<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Codec for Keys in the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value: KvCodec<Uint8Array>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Codec for Data in the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            key: KvKeyCodec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Codec for Keys in the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value: KvPayloadCodec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Codec for Data in the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/kv/types/KvDeleteOptions.html b/docs/kv/types/KvDeleteOptions.html index 312570da..ea8da5ca 100644 --- a/docs/kv/types/KvDeleteOptions.html +++ b/docs/kv/types/KvDeleteOptions.html @@ -1,4 +1,4 @@ -KvDeleteOptions | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias KvDeleteOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type KvDeleteOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousSeq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              previousSeq +KvDeleteOptions | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias KvDeleteOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type KvDeleteOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    previousSeq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                previousSeq

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                previousSeq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If set the KV must be at the current sequence or the put will fail.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/kv/types/KvEntry.html b/docs/kv/types/KvEntry.html index 71579ba2..91406075 100644 --- a/docs/kv/types/KvEntry.html +++ b/docs/kv/types/KvEntry.html @@ -1,15 +1,16 @@ -KvEntry | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias KvEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type KvEntry = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bucket: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      created: Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      delta?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      length: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      operation: "PUT" | "DEL" | "PURGE";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      revision: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value: Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      json<T>(): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  bucket +KvEntry | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias KvEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type KvEntry = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bucket: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        created: Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        delta?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        key: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        length: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        operation: "PUT" | "DEL" | "PURGE";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rawKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        revision: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        json<T>(): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bucket created delta? key length operation +rawKey revision value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    json string -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bucket: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    created: Date
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    delta?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    key: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    length: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    operation: "PUT" | "DEL" | "PURGE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    revision: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    value: Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Convenience method to parse the entry payload as JSON. This method +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bucket: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    created: Date
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    delta?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    key: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    length: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    operation: "PUT" | "DEL" | "PURGE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rawKey: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    revision: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    value: Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Convenience method to parse the entry payload as JSON. This method will throw an exception if there's a parsing error;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Convenience method to parse the entry payload as string. This method +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Convenience method to parse the entry payload as string. This method may throw an exception if there's a conversion error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/kv/types/KvKeyCodec.html b/docs/kv/types/KvKeyCodec.html new file mode 100644 index 00000000..3d7d0882 --- /dev/null +++ b/docs/kv/types/KvKeyCodec.html @@ -0,0 +1,27 @@ +KvKeyCodec | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias KvKeyCodec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A key codec is used to encode and decode keys before they are stored +or returned to the client in a Key-Value store.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The codec transforms each token (part between dots) in a key string, allowing +for custom encoding/decoding while preserving the hierarchical structure of NATS subjects.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Enables custom encoding of keys (e.g., base64, encryption, or custom mappings)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Preserves the ability to use NATS subject wildcards for filtering
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Ensures proper storage and retrieval of keys with special characters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      1. Must preserve the dot-delimited structure of NATS subjects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2. +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      2. Must handle wildcard tokens (* and >) without modification
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        3. +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      3. Must be able to properly encode/decode each token independently
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        4. +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      4. Must be deterministic (same input always produces same output)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        5. +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      // Original key: "users.john.profile"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      // Encoded key: "dXNlcnM=.am9obg==.cHJvZmlsZQ=="

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      // With wildcards (these remain unchanged):
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      // Original key: "users.*.profile"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      // Encoded key: "dXNlcnM=.*.cHJvZmlsZQ=="
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Note: This codec is specifically for subject-compatible transformations of keys, +not for general data transformation or serialization. It operates at the token level +to preserve NATS subject semantics, ensuring that filtering, watches, and other +subject-based operations continue to work properly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type KvKeyCodec = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          decode(k: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encode(k: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      decode +encode +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Decodes a key or key token after retrieval

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • k: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Encodes a key or key token before storage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • k: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PurposeRequirementsExample
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/kv/types/KvLimits.html b/docs/kv/types/KvLimits.html index 9704dcb1..85efe35b 100644 --- a/docs/kv/types/KvLimits.html +++ b/docs/kv/types/KvLimits.html @@ -1,6 +1,7 @@ -KvLimits | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias KvLimits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type KvLimits = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            compression?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            history: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            maxValueSize: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mirror?: StreamSource;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            placement: Placement;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            replicas: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            republish: Republish;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sources?: StreamSource[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            storage: StorageType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ttl: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        compression? +KvLimits | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias KvLimits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type KvLimits = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              compression?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              history: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              markerTTL: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max_bytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxValueSize: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mirror?: StreamSource;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              placement: Placement;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              replicas: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              republish: Republish;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sources?: StreamSource[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              storage: StorageType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ttl: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          compression? description history +markerTTL max_bytes maxValueSize mirror? @@ -12,18 +13,22 @@ ttl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          compression?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets the compression level of the KV. This feature is only supported in servers 2.10.x and better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets the specified description on the stream of the KV.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          history: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Number of maximum messages allowed per subject (key).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_bytes: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The maximum number of bytes on the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          maxValueSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The maximum size of a value on the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mirror?: StreamSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Maintains a 1:1 mirror of another kv stream with name matching this property.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          placement: Placement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Placement hints for the stream hosting the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          replicas: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Number of replicas for the KV (1,3,or 5).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          republish: Republish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Republishes edits to the KV on a NATS core subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sources?: StreamSource[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Stream names to replicate into this KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          storage: StorageType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The backing store of the stream hosting the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ttl: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The maximum number of millis the key should live +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets the specified description on the stream of the KV.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          history: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Number of maximum messages allowed per subject (key).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          markerTTL: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          When set, this will turn on the stream's allow_msg_ttl, and +set the subject_delete_marker_ttl to the specified number of +milliseconds. Note that while you can change this setting, you +cannot make it 0 once set as the allow_msg_ttl cannot be disabled once set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          max_bytes: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The maximum number of bytes on the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          maxValueSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The maximum size of a value on the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mirror?: StreamSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Maintains a 1:1 mirror of another kv stream with name matching this property.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          placement: Placement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Placement hints for the stream hosting the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          replicas: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Number of replicas for the KV (1,3,or 5).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          republish: Republish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Republishes edits to the KV on a NATS core subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sources?: StreamSource[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Stream names to replicate into this KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          storage: StorageType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The backing store of the stream hosting the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ttl: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The maximum number of millis the key should live in the KV. The server will automatically remove keys older than this amount. Note that deletion of delete markers are not performed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/kv/types/KvOptions.html b/docs/kv/types/KvOptions.html index 39f6ae5a..34951a57 100644 --- a/docs/kv/types/KvOptions.html +++ b/docs/kv/types/KvOptions.html @@ -8,4 +8,4 @@ 2.10.x and better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • streamName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The underlying stream name for the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • timeout: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          How long to wait in milliseconds for a response from the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/kv/types/KvPayloadCodec.html b/docs/kv/types/KvPayloadCodec.html new file mode 100644 index 00000000..a9f99947 --- /dev/null +++ b/docs/kv/types/KvPayloadCodec.html @@ -0,0 +1,26 @@ +KvPayloadCodec | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias KvPayloadCodec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A payload codec for transforming data before storage and after retrieval in a Key-Value store.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The KvPayloadCodec handles the transformation of values between the application layer and +the storage layer in the NATS Key-Value store. All values in NATS KV are ultimately stored +as binary data (Uint8Array), and this codec provides a way to customize how data is +encoded/decoded.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1. When storing: Application data (string or Uint8Array) → encode() → Uint8Array (stored in NATS)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              2. +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            2. When retrieving: Uint8Array (from NATS) → decode() → Uint8Array (returned to application)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              3. +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • The codec always returns Uint8Array, but KvEntry provides convenience methods (string(), json()) +for parsing the binary data into other formats
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Even when the input is a string, the codec must convert it to and work with Uint8Array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • The decode method must always return a Uint8Array, even if your application uses string values
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Custom codecs can implement compression, encryption, or other transformations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Compression: Reduce the size of stored data
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Encryption: Secure sensitive data at rest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Simple compression codec using a hypothetical compression library
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const CompressionCodec = (): KvPayloadCodec => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              return {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                encode(v: Payload): Uint8Array {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Convert string to Uint8Array if needed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const data = typeof v === "string" ? new TextEncoder().encode(v) : v;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Apply compression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  return compressData(data);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                decode(d: Uint8Array): Uint8Array {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Decompress the data
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  return decompressData(d);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type KvPayloadCodec = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                decode(d: Uint8Array): Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                encode(v: Payload): Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            decode +encode +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • d: Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • v: Payload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PurposeData FlowImportant NotesExample Use Cases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/kv/types/KvPurgeOptions.html b/docs/kv/types/KvPurgeOptions.html new file mode 100644 index 00000000..f5b99f0d --- /dev/null +++ b/docs/kv/types/KvPurgeOptions.html @@ -0,0 +1,12 @@ +KvPurgeOptions | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias KvPurgeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              KvPurgeOptions: KvDeleteOptions & { ttl: string }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ttl: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If set, the entry will notify when deleted after the specified duration. +Note that for this option to work, the KvBucket must have the +markerTTL option.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Note that the duration is specified as a string. The duration format matches +Go duration strings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • "10s" - 10 seconds
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • "1m" - 1 minute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • "1h" - 1 hour
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If a unit suffix is not specified, it is assumed to be seconds.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/kv/types/KvPutOptions.html b/docs/kv/types/KvPutOptions.html index 7f5a790c..777d3815 100644 --- a/docs/kv/types/KvPutOptions.html +++ b/docs/kv/types/KvPutOptions.html @@ -1,7 +1,7 @@ -KvPutOptions | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias KvPutOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type KvPutOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    previousSeq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    timeout: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                previousSeq +KvPutOptions | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias KvPutOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type KvPutOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      previousSeq: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousSeq timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousSeq: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set the KV must be at the current sequence or the put will fail.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  timeout: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Timeout value in milliseconds for the put, overrides Jetstream context's +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  timeout: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Timeout value in milliseconds for the put, overrides Jetstream context's default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/kv/types/KvStatus.html b/docs/kv/types/KvStatus.html index 5849fafb..982856f5 100644 --- a/docs/kv/types/KvStatus.html +++ b/docs/kv/types/KvStatus.html @@ -1,8 +1,11 @@ -KvStatus | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias KvStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    KvStatus: KvLimits & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bucket: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        metadata?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        size: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        streamInfo: StreamInfo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        values: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • bucket: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The simple name for a Kv - this name is typically prefixed by KV_.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +KvStatus | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias KvStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        KvStatus: KvLimits & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            bucket: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            markerTTL: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            metadata?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            size: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            streamInfo: StreamInfo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            values: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • bucket: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The simple name for a Kv - this name is typically prefixed by KV_.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • markerTTL: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Number of millis delete markers will live before they are removed by the server. +Note that this value will be set to 0 if the underlying stream doesn't enable +this feature. This is a feature that must be configured on bucket creation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalmetadata?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Metadata field to store additional information about the stream. Note that keys starting with _nats are reserved. This feature only supported on servers 2.10.x and better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • size: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Size of the bucket in bytes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • streamInfo: StreamInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The StreamInfo backing up the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • values: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Number of entries in the KV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/kv/types/KvWatchEntry.html b/docs/kv/types/KvWatchEntry.html index c5412f70..9a3ecd1a 100644 --- a/docs/kv/types/KvWatchEntry.html +++ b/docs/kv/types/KvWatchEntry.html @@ -1 +1 @@ -KvWatchEntry | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias KvWatchEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        KvWatchEntry: KvEntry & { isUpdate: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +KvWatchEntry | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias KvWatchEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          KvWatchEntry: KvEntry & { isUpdate: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/kv/types/KvWatchInclude.html b/docs/kv/types/KvWatchInclude.html index 12e68da9..ae1b04b3 100644 --- a/docs/kv/types/KvWatchInclude.html +++ b/docs/kv/types/KvWatchInclude.html @@ -1 +1 @@ -KvWatchInclude | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias KvWatchInclude

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            KvWatchInclude: typeof KvWatchInclude[keyof typeof KvWatchInclude]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +KvWatchInclude | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias KvWatchInclude

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              KvWatchInclude: typeof KvWatchInclude[keyof typeof KvWatchInclude]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/kv/types/KvWatchOptions.html b/docs/kv/types/KvWatchOptions.html index 415795cb..b6ba264e 100644 --- a/docs/kv/types/KvWatchOptions.html +++ b/docs/kv/types/KvWatchOptions.html @@ -1,15 +1,15 @@ -KvWatchOptions | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias KvWatchOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type KvWatchOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    headers_only?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ignoreDeletes?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    include?: KvWatchInclude;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    key?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resumeFromRevision?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                headers_only? +KvWatchOptions | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias KvWatchOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type KvWatchOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers_only?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ignoreDeletes?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      include?: KvWatchInclude;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resumeFromRevision?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  headers_only? ignoreDeletes? include? key? resumeFromRevision?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  headers_only?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Notification should only include entry headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ignoreDeletes?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Skips notifying deletes. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ignoreDeletes?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Skips notifying deletes. @default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  include?: KvWatchInclude

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Specify what to include in the watcher, by default all last values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key?: string | string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A key or wildcarded key following keys as if they were NATS subject names. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  include?: KvWatchInclude

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Specify what to include in the watcher, by default all last values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key?: string | string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A key or wildcarded key following keys as if they were NATS subject names. Note you can specify multiple keys if running on server 2.10.x or better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  resumeFromRevision?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Starts watching at the specified revision. This is intended for watchers +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  resumeFromRevision?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Starts watching at the specified revision. This is intended for watchers that have restarted watching and have maintained some state of where they are in the watch.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/kv/types/RoKV.html b/docs/kv/types/RoKV.html index 2e352394..fb8dddd8 100644 --- a/docs/kv/types/RoKV.html +++ b/docs/kv/types/RoKV.html @@ -1,4 +1,4 @@ -RoKV | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias RoKV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type RoKV = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get(k: string, opts?: { revision: number }): Promise<KvEntry>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        history(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            opts?: { key?: string | string[] },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<QueuedIterator<KvWatchEntry>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        keys(filter?: string | string[]): Promise<QueuedIterator<string>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        status(): Promise<KvStatus>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        watch(opts?: KvWatchOptions): Promise<QueuedIterator<KvWatchEntry>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get +RoKV | @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/kv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias RoKV

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type RoKV = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          get(k: string, opts?: { revision: number }): Promise<KvEntry>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          history(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              opts?: { key?: string | string[] },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<QueuedIterator<KvWatchEntry>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          keys(filter?: string | string[]): Promise<QueuedIterator<string>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          status(): Promise<KvStatus>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          watch(opts?: KvWatchOptions): Promise<QueuedIterator<KvWatchEntry>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      get history keys status @@ -7,11 +7,11 @@ Note that the entry returned could be marked with a "DEL" or "PURGE" operation which signifies the server stored the value, but it is now deleted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalopts: { revision: number }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<KvEntry>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an iterator of the specified key's history (or all keys). +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • k: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalopts: { revision: number }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<KvEntry>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an iterator of the specified key's history (or all keys). Note you can specify multiple keys if running on server 2.10.x or better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalopts: { key?: string | string[] }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<QueuedIterator<KvWatchEntry>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an iterator of all the keys optionally matching +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalopts: { key?: string | string[] }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<QueuedIterator<KvWatchEntry>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an iterator of all the keys optionally matching the specified filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalfilter: string | string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          default is all keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<QueuedIterator<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns information about the Kv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<KvStatus>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<QueuedIterator<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns information about the Kv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<KvStatus>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/kv/variables/KvWatchInclude.html b/docs/kv/variables/KvWatchInclude.html index de39487f..f8bae4e1 100644 --- a/docs/kv/variables/KvWatchInclude.html +++ b/docs/kv/variables/KvWatchInclude.html @@ -2,4 +2,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadonlyLastValue: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Include the last value for all the keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadonlyUpdatesOnly: "updates"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Don't include history or last values, only notify of updates

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/obj/assets/hierarchy.js b/docs/obj/assets/hierarchy.js index 88636f05..fb85f0ad 100644 --- a/docs/obj/assets/hierarchy.js +++ b/docs/obj/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzwMKVNfWAgCbHgqm" \ No newline at end of file +window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzytWsqqurQUAmx4Kpg==" \ No newline at end of file diff --git a/docs/obj/assets/navigation.js b/docs/obj/assets/navigation.js index 3371aee0..a458b3b6 100644 --- a/docs/obj/assets/navigation.js +++ b/docs/obj/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJyd0sFPwjAUBvD/pWeiMFSUo5xIMCwi8WA8PNoHG3Tdsr4RCeF/d3MTB8N25fq+7/ulh37sGeEXsSF7Bo0Pd6NYIGcdlgAF+ZFL0Br1bS28CSiSeWMTKsGGPe/x0Dkz5qk0Mr95K8kHIVDYvFrLpE4X66ipFFfLCjmN1TL+29IuKZdVcrr3uk+D3r3XMF5RZ5IuK2XWzplRnOJl5idyUCah2hikInbQXpDAoBWxozZNKIyVtqBVy8G2u+6mn1E+MplVw8GcEVBmIstCO/EdiAf/f+RjbNN8CRwjVI2vfAxsQvF0WOFbvjo3atFVyhbSEBbSJPW9w+c33fipxg==" \ No newline at end of file +window.navigationData = "eJyd0k1PhDAQgOH/MmeiLn5z1JOJBuJqPBgPs+0ouKU0dDBuzP53g+CKy9pSr31nnvQwjx/A9M6QwAVaOjm6rCQJiMAg55CAUGgt2f1B3Mu5VBDBstASkll8to62jPtaOZnvPknKUEqSPm8w5VLTxWs5VtpXzxYJvtLP1c8ur0y32Zff+/HB+ensOB4Zt2QbxbuVrk1z5lzVtJv5SgHKdaGXDqnNAdoNMTq0NgdqqeGi0taD9lMBtt8NN7OGU8Mus58IMOeM3LjIbmCa+IAs8r8PeZN9WqZQUEl6dMqb4BPar+ML3a3M6I4H6V/KG9YFLpRLOozXT5/d+KnG" \ No newline at end of file diff --git a/docs/obj/assets/search.js b/docs/obj/assets/search.js index 76bc4b9c..10d0efa6 100644 --- a/docs/obj/assets/search.js +++ b/docs/obj/assets/search.js @@ -1 +1 @@ -window.searchData = "eJytnFtv27gSx7+L/Wpkw7ucxy7OARbYxRbtuTwEQaDYaurWN8hyd3uCfvcjSrQ0o6Gkkd2n1NZw/sPhj0NaEvs2yw9/nWYPj2+zr5v9evYgZLKY7dNdNnuYvUtPmdW/HtbZaraYnfNt+d1qm55O2ekXcO3uc7HblgbhUmk0+7G4+DNCNv5Wh/2pyM+r4pCP+ptjY+B7MTumebYvOgG2kvJet30oL5WXx+Uau6uVsj1PqbGbokSH5d/5dmhkLpd/4uAglxPGp4n0miHCoqxRGtMbHCisxxqrMb1P+WH3rjT78Ps/vLvN/pWl7Zu9WF0aZm2zW+IoDldEURxujSGK7vt0vc7WIwADo5+LcdfxNJhh7FciTQLggs3QHsObaHMhZ2hPQZ3EcQ3wjJj42JOIpsMfjwdOgT9fvuxICP7Ln4J444iFdBULCPNe6kbly2nAeXWR5RMNxSrP0oKiCYK+GEz3vd2cigHP4fJ0v4djth/wGy4z/S6dMBKikK2K3/afDo1A8f1Yuw8XBqGI+/uQnc7bIuqxvjToEzGwTot0zNE8GPVmoA2pRyXLc0Byn8zF6nqdTV+ioUwwmqQSH4eP5czLonrVlZGRRYvJNivGPM0bq6HQ65h6dcqCcfg+LnQxu1rpNYvzCVRqk1sU3m0PLwyVl9rsaqVeqoAMA6pBje1m/3VMI9jcpMFBthI6BcMb1E6jCIyV7DGN43lUoja5RYFDWWl2K2WnLN2OyQSb6zWKtDifRlUuVlfrnI/rdLyeNVZX6/yVFqvPYzIXo2kqvfX+98GZ6q/yV9+X8+rrUKFsvM0by9FeVPH16FV/GGrBbqrWQNb+yHr2Gc3VCXuW7LTKN8dic9gzXM6x+Wifqkh7lD9n6TrLByZQq9qa3qS4K6/17tE6ksD2Js1hSlo9LiVDWodqXFgZbU2nKo5w+ScnhmDEp3R4Re+6ZC/uMOA+ZtK/n1efz/uvz6fN/0ZGEsVAGl4ZzUC+R3M9Oc+rw+6YZ6fTYDVA3cQtRvs4km1WNUL6EwsSY7RfvhcZM6dzaH+z9mh1wtITCtSI8nGbrrKdb8WThva3aufZcbtZpdyEA/Nblf2mPH0dmNJIuLW+VbcoBramSLO2vEJvoGa8Pxel/UC6gwG/ZpTT/9vmcD59KP8MFw7oen5plrfNRnt6Cb4vs5tddhj6FYMCaK2v0B3I8MeR3wX19Qn72nRVfvs68mMTeJ2HFuxfnSHiK/fVSJm9sx7WZK1DUHjiMjSszlqFoPrERWhYfXwdgNJTloFh3fFKDHWnFOJhXf87PFvzVBvbWzUH93JIkbl5G9EbW2uQJH+pGVPNs3TXe8M8IuztuXffhrUHVzkoylzkiFq8Av/X35/o7XFzddJzgvc926Pm+wn76+35VGTdu/fY0bw1imeljacv9+lrdxZ3JIIF3383Jx9rRv9VOu8ogSuDeVHDzr6l+SZ92U5wiFLwz82W42v+qbaLJwJaPz/77vXJ/ZHtDvl3juDuYsmXfFrMSsXs79nD2+xblldr3MNM3qm7Zdn00ybbrv0rSZdbDeVSGGBdH1bn6p9Pwew/mX++6Y1r61/uZ4vH+4W+v7P3+ulp8XhpXF2ovrj4aL+pGoryk1jI5Z0VCWooSEOBGsryk1woeSeUQA0laShRQ1V+UrGGijRUqKEuP+lYHzVpqFFD09dHQxoa1ND29dGShhY1dH19dKShQw2T8pNZKHOnlxY1TEjDBDUsCXq0sYZL0nCJAfA8uFhaBWVHdODppyeCD+ZH9AIkKEECIyR6GRIUIoEpErovxYJyJDBIwvRlWVCUBGZJeEKSaJ4pTQLjJFxvnilQAhMlPCfLqC5lSmCohEdFROuKoFwJDJb0rAgRy5akZElMlqzIkjFlSdGSndLkaREq2jhSnTBb0uMionVGUrgkhkt6XoSJNqZ0SUyXrOqUjTameEmMl/TECBfNNuVLYr5kxVcUTkkBkxgw6ZkRUcIkJUxiwqRnRkYJk5QwiQlTnhkpYo0VJUxhwpRnRkYJU5QwhQlTsjfbihKmOgugZ0aqaOPIGogJU54ZGcVTUcIUJkyZ3impKGEKE6aq1TDKtqKEKUyY8szIKNuKEqYwYcozI6NrlKKEKUyYqgiLsq0oYQoTpivComxrSpjGhGnPjIqyrSlhGhOmPTMqyramhGlMmK7WRxkbZ00J051tlmdGRfHUkZ0WJkx7ZlR8l0YJ05gw7ZlRJraua0qYxoTpas8VJUxTwjQmTHtmlIsqU8I0Jkwv+xNGCdOYMOOZUVE8DSXMYMJMRVgUT0MJM5gwI3vLkKGEGUyY8czoKNuGEmYwYabayUfZNpQw09nMe2Z0lG0T2c9jwkw/YYYSZjBhxjOjo9sKQwkzmDDTT5ihhBlMmPHMaB3tMyXMYMKsZ0ZHd7yWEmYxYdYzo6NbXksJs5gw65nR0VXSUsIsJsxWhEUnhqWEWUyYrQiLTgxLCbOYMOuZMVG2LSXMdn4yemZMlG0b+dWICbOeGRPdk1hKmMWE2aS36FtKmMWE2WXvrLKUMIsJc/e9s8pRwhwmzIneieEoYQ4T5mQv244S5jBhzjNjovPZUcIcJsxVPyOjC52jhDlMmDO9s8pRwhwmzFWERfdhjhLmOjcmXO+UdJF7E5gwV92diC6xjhLmMGGuv4Y5SpjDhCWeGRPdASaUsAQTlnhmTLSSJJSwBBOWeGbMMnpLhhKWYMIS1d+YEpZgwhLPjI2WoYQSlmDCkupORbQMJZSw8FV1f/JblhfZ+rf6PuXj4ww/g3ybPYdbmO095LdZWYke3n78aG9Zlp/AXUt/zeu9VKdFVvXhp9bTfevofoKfc74lrnTrSk9zdawOsBCHrnUomMGFJ6etDwUyVe61q2Zl+eU4a54ggLyDkBJeSOiZKkgWiKvcJ9VxLZkewSGb1qMA2apbBrcifBQ8UC7HYYBnAIngxVg/TAUuTOtC8ui4nE5rnYCUyZCx0DPJ9FifVgBhLYFLHhXoKTXgDHRQh7BM+Ot4pDRnHECPQeYlL/OXg3UgtNZHmAAupE3xPNaHYEDWLIjKsHzUT4haFxZ0LOHxEDupB2Ym8Bd6x3P7iuuFBNNI8catOc8BvABUlWB5ad7OBQMH8qx5k7d+7AyGChQsGXBUvNnyBcUCJorgTZT69VGQE8hhANHwQgGnP4A/sN4o3ljXhztAdsBgy/uQHR7Q4J1FUNRBFw1vwLovuAJnYIoY3ky9PBYF8wz0MGH2rHkXBpAIMNJhfpnw1/H4rp+rApcgV1rXjTSvxB2q1xAI6sCh5HFVO8rD2UXgCqAleamvXRFIRQI88YgAnrpTSIHR1FO6WHnbZZ1BhRs2Hhsdb83778ApKBSGRwZwGnGoQZ8Nb5oDh8dzcahe1AQOwZDYyYN7OYkEVh4QoLUT/FWngLoUG1DzHa/QHqrD3a0L0D/BjKc6TwyohTst5iBGUACBGN5SCt6JBgMGODXLUHR4lYK+HgvcAlItD6zq5B5YgcCmQ/Ey3ZzKA17AiCteiWhfGwTdAcHYsJY5Xo2oz/CBiEC1VzwGL68UApBBOXa8adZdAQ0YeMcbITo9JaBQ8ahpXh0E2QWDZMPvKcermcFb9RYS7BzALwk/ZxJmnsAbhsAhAMDxaKxfYAMuQK4S3rxv3v8GXsDGxfJyRP/PC7CFab2FyS+YTgtEtQZU25Bwx5tvl2OhgCoweppX28KhT1AfQZ40I9tPi9lxc/SbgrLJ49OPH/8HT1s03w=="; \ No newline at end of file +window.searchData = "eJytnNuO2zgSht9FfWv0NM9yX2axCwwwgwSZnd0LoxGobaXjxLYMWc5MttHvvqBES1UqSirZueqMVay/WPxYpA6c16Qs/jolj6vX5Nv2sEkehUwXySHb58lj8i475Vb/o9jk62SRnMtd8pisd9nplJ9+Adfuv1T7XbK4XEoek+RtcfFnhGz9rYvDqSrP66ooJ/3dYWPge5EcszI/VL0AO0n5oLs+bPJ1scmn5Vq7q5XyA0+ptZujRIflz3I3NjKXyz9xcJDLGePTRnrNEGFR1ihN6Y0OFNZjjdWU3uey2L+z+s+Pv/3Tu9seXljavtmz1edyl3fNbomjKq6IoipujSGK7odss8k3EwADo5+Lcd/xPJhh7FciTQLggs3QnsKbaHMhZ2jPQZ3EcQ3wjJj42JOI5sMfjwdOgffPX/ckBP/jT0G8dcRCuo4FhPkgdavy9TTivL7I8omGYl3mWUXRBEFfDOb73m1P1YjncHm+3+KYH0b8hstMv0snjIQo5Ovq18PnohWofhwb9+HCKBRxfx/z03lXRT02l0Z9IgY2WZVNOboLRoMZ6EIaUMnLEpA8JHOxul5nO5RoKBOMZqnEx+GPqijzqF59ZWJk0WKyy6spT3et1VjoTUyDOqeqLH5MC13MrlZ6yeN8ApXG5BaFd7vimaHy3JhdrTRIFZBhQDWqsdsevk1pBJubNDjI1kKnYHiD2mkSgamSPaVxPE9KNCa3KHAoO55vpuyUZ7spmWBzvUaVVefTpMrF6mqd83GTTdez1upqnb+yav1lSuZiNE9lsN7/NjpT/VX+6vt8Xn8bK5Stt7vWcrIXdXwDevUfhlqwm6s1krXf84F9Rnt1xp4lP63L7bHaFgeGyztsPtmnOtIB5S95tsnLkQnUqXamNynu8yob3KP1JIHtTZrjlHR6XErGtIp6XFgZ7UznKk5w+Z4TQzDiUzq+ovddshd3GPAQM9nfn9Zfzodvn07b/02MJIqBNLwympF8T+Z6dp7Xxf5Y5qfTaDVA3cQtJvs4kW1WNUL6MwsSY7Sff1Q5M6d30P5m7cnqhKVnFKgJ5eMuW+d734onDe1v1S7z4267zrgJB+a3KvtNefYyMqWRcGd9q25VjWxNkWZjeYXeSM34cK7eH6uRdAcDfs04lvn3bXE+fcy/b8cLB3R9d2lWds0me3oJfiiz231ejN3FoAA66yt0RzL8x8R9QXN9xr42W3/bHl4mbjaB17vQgn3XGSK+cl+NlNk763FN1joEhWcuQ+PqrFUIqs9chMbVp9cBKD1nGRjXna7EUHdOIR7X9ffh+Yan2treqjm6l0OKzM3bhN7UWoMk+UvNlGqZZ/vBB+YRYW/Pffo2rj26ykFR5iJH1OIV+L/++cRgj9urs94TfBjYHrW/z9hf786nKu8/vceO7jqjeFa6eIZyn730Z3FPIljw/fdz8kfD6L9/HPtQgyujeVHjzr5n5TZ73s1wiFLwr+2O4+vuc2MXTwS0/vTJd29I7vd8X5Q/OIL7iyVf8mmRbA+b/O/k8TX5npf1GveYyHt1v0wWyedtvtv4T5IujxrWxT7AuinW5/qfT8HsP7l/v+mNG+tfHpLF6mGhH+7tg356WqwujesL9Q8XH90vdUORLFZiIZf3VqSooSANBWook8VKLpS8F0qghpI0lKihShYrFWuoSEOFGupksdKxPmrSUKOGZqiPhjQ0qKEd6qMlDS1q6Ib66EhDhxqmyWJlFsrc66VFDVPSMEUNl8liZWMNl6ThEgPgeXCxtArKjujBM0xPBB/MjxgESFCCBEZIDDIkKEQCUyT0UIoF5UhgkIQZyrKgKAnMkvCEpNE8U5oExkm4wTxToAQmSnhOllFdypTAUAmPiojWFUG5Ehgs6VkRIpYtScmSmCxZkyVjypKiJXulydMiVLRxpDphtqTHRUTrjKRwSQyX9LwIE21M6ZKYLlnXKRttTPGSGC/piREumm3Kl8R8yZqvKJySAiYxYNIzI6KESUqYxIRJz4yMEiYpYRITpjwzUsQaK0qYwoQpz4yMEqYoYQoTpuRgthUlTPUWQM+MVNHGkTUQE6Y8MzKKp6KEKUyYMoNTUlHCFCZM1athlG1FCVOYMOWZkVG2FSVMYcKUZ0ZG1yhFCVOYMFUTFmVbUcIUJkzXhEXZ1pQwjQnTnhkVZVtTwjQmTHtmVJRtTQnTmDBdr48yNs6aEqZ72yzPjIriqSM7LUyY9syo+C6NEqYxYdozo0xsXdeUMI0J0/WeK0qYpoRpTJj2zCgXVaaEaUyYXg4njBKmMWHGM6OieBpKmMGEmZqwKJ6GEmYwYUYOliFDCTOYMOOZ0VG2DSXMYMJMvZOPsm0oYaa3mffM6CjbJrKfx4SZYcIMJcxgwoxnRke3FYYSZjBhZpgwQwkzmDDjmdE62mdKmMGEWc+Mju54LSXMYsKsZ0ZHt7yWEmYxYdYzo6OrpKWEWUyYrQmLTgxLCbOYMFsTFp0YlhJmMWHWM2OibFtKmO3dMnpmTJRtG7lrxIRZz4yJ7kksJcxiwmw6WPQtJcxiwuxycFZZSpjFhLmHwVnlKGEOE+bE4MRwlDCHCXNykG1HCXOYMOeZMdH57ChhDhPm6tvI6ELnKGEOE+bM4KxylDCHCXM1YdF9mKOEud6DCTc4JV3k2QQmzNVPJ6JLrKOEOUyYG65hjhLmMGGpZ8ZEd4ApJSzFhKWeGROtJCklLMWEpZ4Zs4w+kqGEpZiwVA03poSlmLDUM2OjZSilhKWYsLR+UhEtQyklLPxUP5/8npdVvvm1eU65WiX4HeRr8ik8wuyeIb8m1iWPr29v3SPLx9c38NTSX/N6z/VpkXVz+Knz9NA5epjh51zuiCvdudLzXB3rAyzEoescCmZw4c1p50OBTGnVNLMpy1n7BgHkHYSU8kJC71RBskBcxoS4lkyP4JBN51GAbDUtg1sR/lPwQLkchwGeASSCF2PzMhW4MJ0LyaPjcjqtcwJSJkPGQs8k02NzWgGEtQQueVSgt9SAM9BBHcIy4a/jkdKecQA9BpmXvMxfDtaB0DofYQK4kDbF89gcggFZsyAqw/LRvCHqXFjQsZTHQ+ykHpiZwF/oHc/tC64XEkwjxRu39jwH8AJQVYLlpf06FwwcyLPmTd7mtTMYKlCwZMBR8WbLVxQLmCiCN1Gaz0dBTiCHAUTDCwWc/gD+wHqjeGPdHO4A2QGDLR9CdnhAg28WQVEHXTS8Aet/4AqcgSlieDP18loUzDPQw5TZs/ZbGEAiwEiH+WXCX8fju3mvClyCXGndNNK8ElfUnyEQ1IFDyeOqcVSGs4vAFUBL8lLfuCKQihR44hEBPPWnkAKjqed0sfa2z3uDCjdsPDZ63trv34FTUCgMjwzgNOJQgz4b3jQHDo/nqqg/1AQOwZDY2YN7OYkEVh4QoLUz/NWngPoUG1DzHa/QFvXh7s4F6J9gxlOfJwbUwp0WcxAjKIBADG8pBd9EgwEDnJplKDq8SkE/jwVuAamWB1Z9cg+sQGDToXiZbk/lAS9gxBWvRHSfDYLugGBsWMscr0Y0Z/hARKDaKx6Dl08KAcigHDveNOuvgAYMvOONEJ2eElCoeNS0nw6C7IJBsuF+yvFqZvBWf4UEOwfwS8PtTMrME/jCEDgEADgejc0HbMAFyFXKm/ft99/AC9i4WF6O6P/zAmxhOm9h8gum0wpRrQHVNiTc8ebb5VgooAqMnubVtnDoE9RHkCfNyPbTIjluj35TkCePq6e3t/8DT1s03w=="; \ No newline at end of file diff --git a/docs/obj/index.html b/docs/obj/index.html index f9b950dd..d79834ad 100644 --- a/docs/obj/index.html +++ b/docs/obj/index.html @@ -1,5 +1,5 @@ @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/obj

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        License -jetstream +obj JSDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        JSR JSR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/obj/types/Placement.html b/docs/obj/types/Placement.html index 933b8e08..7c04fc9e 100644 --- a/docs/obj/types/Placement.html +++ b/docs/obj/types/Placement.html @@ -1,5 +1,5 @@ -Placement | @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Placement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Placement = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cluster: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tags: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cluster +Placement | @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Placement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Placement = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cluster: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tags: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cluster tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cluster: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The cluster to place the stream on

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tags: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags matching server configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tags: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags matching server configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/obj/types/StorageType.html b/docs/obj/types/StorageType.html index 4d282fa0..54bd8d47 100644 --- a/docs/obj/types/StorageType.html +++ b/docs/obj/types/StorageType.html @@ -1 +1 @@ -StorageType | @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias StorageType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              StorageType: typeof StorageType[keyof typeof StorageType]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +StorageType | @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias StorageType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                StorageType: typeof StorageType[keyof typeof StorageType]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/obj/variables/StorageType.html b/docs/obj/variables/StorageType.html index 7b274660..f0ec3d93 100644 --- a/docs/obj/variables/StorageType.html +++ b/docs/obj/variables/StorageType.html @@ -1,3 +1,3 @@ StorageType | @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @nats-io/obj
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable StorageTypeConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  StorageType: { File: "file"; Memory: "memory" }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyFile: "file"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Store persistently on files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReadonlyMemory: "memory"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Store in server memory - doesn't survive server restarts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/services/assets/hierarchy.js b/docs/services/assets/hierarchy.js index cfe71cb1..090a7bdf 100644 --- a/docs/services/assets/hierarchy.js +++ b/docs/services/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyNjzEOwyAUQ+/imbQSEo3CBXqAjlUGBD8KKoHqQ7pE3L2kqrp0yeLBft/W38AplQx979UowDQFssWn2KwNctg1moWgcSN+eUsQePjooKW6CKwcWuRjIZ6MpXz+Uqe5LKGhNpjcqlCy6/az7oeiCvTqv//KaX0eG/mgB5ZaOPvgmGL7Uw5jrfUNvQpTAw==" \ No newline at end of file +window.hierarchyData = "eJyNjbEKgzAURf/lzrGFgBXfD/QDOopDSJ4YGpPyEl0k/14spUsXlzude84OSalk0NC1o4LwFNgWn2IG7dD9sdEsDMKDZfOWofD00YF0e1NYJYDgY2GZjOV8/VKXuSwBCjaYnEEo2TXHrfmhqApd+++/S1pf5yIf9ERJwc4+OOEIGnQ/1lrfvQpTAw==" \ No newline at end of file diff --git a/docs/services/assets/navigation.js b/docs/services/assets/navigation.js index b2af8682..3ed530b8 100644 --- a/docs/services/assets/navigation.js +++ b/docs/services/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJyN1F1PwjAUBuD/smuiMoMf3BIiXKCJGG+MF2U9g8atXdrjIjH+d8ug2cbacm77nvNsOf34+E0QfjCZJmvQtchgrrXSySipGO7salYwY8Bcd9OrHZaFLfkSkifTcfrwN2qVOis93XY12nXU20YhEXTOsvbL/fZ0cjdsnxUCJMaQYwWBetLqu4pJTQEBWpltjLExAXkFUylpovNxNTFuLnmlRHdEuK8s4dbPem8e78eT1NO/lLkKGYeM6rxUKOw/h6hTTNXWyDBoNeEl6ZmVwKPcsOKS6U6ekrnYnnO9kCgtmOQF6AB1SonWktvrIHAfwFxM1TzHohMRlRUg4wxZQHIxUXPX4s0aAbFbQlS9Z6ObEZ130JsAc4iISvMozxSHBTDePRk104JtirPnu63s+7chmsZSSf+ODMzwrvjQ/iAH2HCYFvn8B1MiXzE=" \ No newline at end of file +window.navigationData = "eJyN1MluwjAQBuB38RmVEkSXXBECDrRSqXqpejDxJFhNbMueRkUV716xRFlt5pp/5os0HvvzjyH8IovZFmwpE1hYqy0bMcNxz2KW5Nw5cONmerfHImcj9i2VYPEkejqOaqVMioHuMimCXRe9bpQKwaY8qf/cbo9mD/32eS5BYQi5VBCopdU/JiSdCwjQxmUhZuMyAvIGzmjlgvOpakLcQgmjZXNEeDDgxtX3Tu/98+NkFg30r1WqfcYpozqvBqVWzkddY6q2RY5e6xzekl54ASLI9StumdXmaZXKrMu1QqK04krkYD3UNSVaawEKJR48WBVTtYG1aEREZQPIBUfukaqYqFXX4v1gwCM2S4jq4G40M6LzAXbnYU4RUTk/ynMtYAVcNDej5FbyXd55vuvKtj/10TSWSg6fSM/0n8oQ2h5kD+sPcxodv/4BUyJfMQ==" \ No newline at end of file diff --git a/docs/services/assets/search.js b/docs/services/assets/search.js index b3d99ced..8b3750c0 100644 --- a/docs/services/assets/search.js +++ b/docs/services/assets/search.js @@ -1 +1 @@ -window.searchData = "eJytnN9z2zYSx/8X+VV1jJ+k8tbp9No8NL25ZPri8XgUiUnYsyUdKfsuk8n/fgQJirvcBbWU/VJXIna/wO4HC5AC831R7f9bL97efl/8u9xtF2+VzpeL3fqxWLxdfCiq53JT/FpV+2qxXDxVD82Xm4d1XRf1G3jx+uvx8aFpEa81rRY/lr1Hp/TJ42a/q4/V0+YocXiFWwPny8VhXRW747iPg6i60RaobguRXNtslo6+sUO8ynpexK7K5vv2uyIaXK593M/UPu5foo0wed48UsHmy9fBonckwyH0JYHBbjPhvL0o8onCvt5uJ5x2V+d73TyUodFEKPoGMt/Oj+f0yXe5OxbV5/VmYGQyayigDe/H/eFQbM95C6CfWk5ylpKqhULzZcbp/HW3PexLEP2UVNO2GNoOcsd6+1NZ/1TuvhZVeWz7MkP+t2r/dJBof4kNX0W43H3en09i1+iiwB7K3ZezArHRRQJVURfnc9a3ukiiPq6PtYDArtWFEvvzyY+NxAJ09v+C6wsV6hpMVoI5/AB3Iopi/y5jCYpJiJoWO5d0qCZKPZWj+TlXBNrr8uzIqtrgNFnamOF0Xb28nmFVWtQkkjSAf9RThDRX5Yvcdn1cC3xdxXazynHoZkL2a7HeFtUUeSfloelriVfF4eGbRLpv+FrCdTm1xJ9ku2avJvr06e9iMzU1BuFT0xeIoynyd73fSZRju9eSbRbCw34nCvbQ9JXF8Z3K+R6IblQmZJubh+mVY0hz3/IlI6ZV6V/tOOqpzXffRF6fjt8OYodXsfFkBE+9hGFcZcoN92tkNQl+6zf91/LOf13vtg9FNeXnamjDd/vUmYTGY3FcoyLOiYBGl6n856l4KiYl+haX+R8XKU6Bq05nNFKZfQc3dFgrXJJn+Ez0T87kGWi7lrrFD3/OKcVGl6u0mbz/gnY2KTHc9nLN6fwPelIGRlopDv48HMumGCRk49UzO1He8we0scZ+22uzvL5v/mynXNMGcobXz0W1/lLcH6p9U1nrZmm4P5YEtITCVdqazxAzFMnWdLoTkzNLrtiYH+8LtG5P6yKDl6ozszulOznHZyg+PXa9F+J0hQxeQ70qmgpSS3G+Gpm8tAeXEf/6pKcrbqoPkror1+erb0r7XA2e1B1Xtv6xwX73ufwy6gC6NuOWtqg3VdnW7rMOr3Dj6UcbXR/n7QQYybNbAZEeUy0YrclCIdLhdn6M0PT2T6TUPl/6nd0yM4Jt63ObZ5Fus4DVIlaGhvPUEsxPDjVenLVLiKbvtk13yuM33nF/9SLPdNsMrlzi8Y/JWdNfffF+nPMnnoenPp4dTX9v+RHetKIewBaXxIvb+8FLl/j8q6g+8S7DlUmPhjhrn3r8st8Wv7eP7U5+n9dVuf70MPqtdmh4iYxI4iL3bCKJf3EyEaLv3v/jzxk+Rb8oIKv7+/Y5SEL+n+/e/zZHXvIbwwz5Dx9//vhhjr7oV4fpDtD8IuRJJ85iPyOfJ1+iPLatX5K/QU6SN4HcmXwNeqI8IcG75aLRK/63ePv9tAa/Xehrc71qTD+XxcM2HN3pdzqb/eNj97Pedr95av/3Ljb7qwinJkLjrvWbm8Xy9mZpb679jb27W972xu2F9ovex/BNa6iaT2pp3LVdeWSoiKFChrr5pDlFTQw1MjTNJ8MZGmJokKFtPlnO0BJDiwxd88lxho4YOmToU8HxxNAjw6z55DnFjBhmyDBvPmWcYU4Mc2TYEHSbc4YrYrjCAAQeVpylouyoETwtPSx3iuEHA6QCFkqxxpQhhSFSAQ2lWXApRwqDpAIeyrDGlCWFYVIBEWWXenXtVY6NKU8KA6VaohxrTJlSGCoVUFEsVopypTBYKuCiMlaZsqUwXCogo1i8FOVLYcB0YEaxhGlKmMaEaZWMtqaE6VGJ0sloa6ZKYcK0SQZMU8I0JkwHZjQ7MTQlTGPCtEuyrSlhGhOmfZJtTQnTmDAdmNHslNSUMI0J04EZzXebEqYxYTowo9llQVPCNCbMBGY0uzQYSpjBhJnAjGaXB0MJM5gw066CnoPEUMLMaCEMzGi22htmLcSEmZYwdkoaSpjBhJnAjGanpKGEGUyYCcwYlm1DCTOYMBOYMSxhhhJmMGEmMGPYTYehhBlMmAnMGH7jQQkzmDAbmDH85oMSZjFhNjBj2DJkKWEWE2YDM8Zzs8pSwiwmzJoknpYSZkfbrcCMYfG0zI4LE2ZdesyUMIsJsy1h+dLoa2UUNqaEWUyYbQlbsQGjhFlMmM3TAaOEWUyYDcxYdmJYSpjFhLnAjGUnhqOEOUyYC8xYdmI4SpjDhLnAjGUnhqOEOUyYM8mi7yhhDhPm2h09O6scJcyNNvUuCYlj9vWYMBeYsfw9ASXMYcJcYMay+zBHCXOYMBeYseyscpQwhwlzqyTbjhLmMGH+Jsm2p4R5TJhvCWOXG08J85gw3xLGLjeeEuYxYd4kK4mnhHlMmLdJSDwlzGPCvEuWXk8J86Nbx8CMY4uBZ+4eMWE+MOPYYuApYR4T5gMzji0GnhLmMWE+MOPYYuApYR4TlgVmHDufM0pYhgnLAjOOnZIZJSzDhGU6CUlGCcswYVlgxrF5zihhGSYsC8w4dj5nlLAME5a1TyZyVpkSlmHCspYwdlZllLBs9ICifULB4pkxzygwYVmeDhglLMOEZe29JHtHl1HCMkxY3t5LsnnOKWE5Jixv7yXZO7qcEpZjwnKdTFVOCcsxYblJjjmnhOWYsNymx0wJyzFhuUuPmRIWv2qfUz4X1bHYvuueV97edm9GfV/cxyeYWf/A9Psib/7z48fwvLL5BB5ZhmtBBJ1BH/wMb419XyjT2Ta3tEKP8TwAcGeAOxvdeZm71LmewbsF3puNkMRr/2bX4CQffKxkLtr3GAcHIGLCPsAX7UCsQKg6S1mgup8QQX9gh/LOyBmZK3gYAcR5NXj0sjFybBmQLiOLde+m++0CuAK8WzvL1b4/cgfGdwO8zetY/NUB+AJpbG4LJL5OhwjA+CzokdBL/5oCIAEEXMvGNQ60Ah1RLk7giGe26v7mMrjGb+OC0QIupK76FxFBV0EWlRL56U79g4ABrIysK/AEHqAAhM3J+BxOA4DAOIBBjLqNWfCxOmeyCdn9iAVcg7pnfawSvWtZj4P5Nj0RQBlysnSEl4QHB36wz2Tm4HAg6AeIoZNVVHzKD7gCXXKyPnW/ggJIQW9UDLvWcR7dxL+y8E8tjIBjJ9sPxPNTABAwWBt76GU7AXQ4EHgEy4jNInKyshRfhAIzFUwwIyuQ8eVUkAswQiVL5+llHdATMJGMLHP4hRvgCgTIyEJd9++bD16AEyWLTHRC90YK+NLzfMXzlIBJECcvqwep9QIU+lmdah2F7dvXeHBncOnASDNZlYBOqUMPOpnJ4IoOybzRwJWWERZdMTsLB8qyl5WG6Kw8HesD3sDS7WVTufc22mg4MKGzWVnlFk4Hymw2C7bHGlGrwXZOz0pjdXobDVRA4M1c5K17wwwMFK6S/Y5gVlrJwu3A4pHNwu25PdUEPIEpn8W9RS7brrSvoII0gHwaYT7H41JgXCreF+kYsjxurnJh1UVnf8GAwUz1wirS/msDoJcgZko4o5i9MLyZFEY8vpQJaAWjMcLR9EfzQeoAoSbuI2wMu41p8MIJ3/5LOCDcYJcjcjD+R3nA6gS2JjJXo4loQF01sgl4Os4NRgTy5gUF4m7Z7DAPxUO5a0xu7378+D88aQN+"; \ No newline at end of file +window.searchData = "eJytnE1z2zgShv8LfdU4wicp37amZmdySGZrMzUXlculSIzDWVvSkLJ3Uy7/9y2QoNitblBN2aekROB9AfSDBkiCfsnq3X+b7Gb5kv2n2m6yG6WLWbZdPZbZTfalrJ+rdflLXe/qbJY91Q/ZTbZ+WDVN2XyAF6+/Hx4fsll/LbvJstdZr+iUPiqud9vmUD+tDxLBK1waiM+y/aout4fTNg6maq4tcN2UIru22CQfPbfDeFXNtBG7qpqm+62MFS73Puwmeh92b/FGmDyvH6nh8/rxfbDohWQ4hLYkMNiuR8TbiyJNNOyrzWZEtLs6XXX9UIVCI0PRF5BpO386p4/a1fZQ1t9W64GR0aihAa2aL4fdfl9uzqkF0I8lRzlLWTVCo+k2p+H8ZbvZ7yow+imr1WZTDmUHu0Oz+alqfqq238u6OrRtmWD/a7172ku872PBdzGutt9254PYFbpoYPfV9v6sQSx0kUFdNuX5mPWlLrJoDqtDIyCwK3Whxe588GMhsQGd/T/j/EKNugKjmWAKP0BORFFs32UsQTMJUeNm54IO3UShp3Y0PueSQHtdHh1ZVhtEk6mN6U7X1MvzGXalSU1iSQfwUzNGyKfmXr7IbVaHlUDrKpablI5DMxO238vVpqzHyDs6D0Xfy7wu9w8/JNZ9wfcybqqxJf5o2xV7N9Onr3+V67GpMRgfi77BHE2Rv5rdVuIcy72XbV02+91WNNhD0Xc2x3cq51sgulEZsW0O9fjKMYS5L/mWHtOs9O+2H83Y5rsvIs9Phx97seBVLDw6gsdWwmFc5MoN92tkNQm6zYf+Z3njv6+2m4eyHtO5GsrwzT42JuHxWB5WKIlzJqDQZS5/P5VP5ahFX+Iy/dMkxTlw2emMRyqyH+GGDnuFS/IInxn9o5g8Am3TUrf44Z9zTrHQ5S5tJO/u0c4mZYbLXu45Hv/BT8rAiVeKg9/3h2q3bRK28eqZnSiv/AVtrLFue22S6ufVY7kZk6YF5Ayvnst6dV/e7evdumyaant/d6gIaAmHq3RtPkJMVyRb0/FGjM4suePDqjnclWjdHvdFFd7qzszulO/oHJ/g+PTYtV6I0xWq8B7udfn3U9lIcb46qfLWFlxG/PuTns64qTZI8q7cn8++Ke9zOXjU9zSz9Y8Ndttv1f1JA9C1Cbe0ZbOuqzZ3nxW8woXHH210bZy2E2Asz24FRH5MtmC8RhOFyIfb+TFG49s/kVP7fOk3dsvMGLalz22eRb7PZd2IWBkKTnNLMD/a1Xhx0i4hVv24KbeH6vCDF+6vXqRMt83gyiWKn0ZnTX/1zftxTk88D49tPNub/t7yD3jTiloAS1wyXtzeD166RPPPsv7KS4Yro4qGiLVPPX7ebcrf2sd2R93nVV2tvj6cvKsdCl5iI7K4SJ4NJNEXBxMh+vHzP3+foCl6o4Bq3d21z0ES9v/6+PnXKfaSdwwT7L/88Y8/vkzxF711GG8AjS9CnjTiLPYT4nnUEsWxLf2W+A12krgJ7M7Ea/ATxQkZ3s6yarsp/5fdvBzX4JtMX5vrRTbLvlXlwyYc3el3Ouvd42P3Wm+zWz+1/72Nxf4sw6mJULgr/WGezZbzmZ1f+7m9vZ0t+8rthfaHXmP4pa2ostlSzYy7tguPKipSUaGKOpstNeeoSUWNKppstjRcRUMqGlTRZrOl5SpaUtGiii6bLR1X0ZGKDlX0qcHxpKJHFfNstvScY04q5qhikc2WOVexIBULVHGRzZYFV3FBKi4wAIGHBVdTUXbUCTwtPSx3iuEHA6QCFkqxlSlDCkOkAhpKs+BSjhQGSQU8lGErU5YUhkkFRJSd6cW1VwWuTHlSGCjVEuXYypQphaFSARXFYqUoVwqDpQIuKmedKVsKw6UCMorFS1G+FAZMB2YUS5imhGlMmFbJ0daUMH2SonRytDWTpTBh2iQHTFPCNCZMB2Y0OzE0JUxjwrRLsq0pYRoTpn2SbU0J05gwHZjR7JTUlDCNCdOBGc03mxKmMWE6MKPZZUFTwjQmzARmNLs0GEqYwYSZwIxmlwdDCTOYMNOugp6DxFDCzMlCGJjRbLY3zFqICTMtYeyUNJQwgwkzgRnNTklDCTOYMBOYMSzbhhJmMGEmMGNYwgwlzGDCTGDGsJsOQwkzmDATmDH8xoMSZjBhNjBj+M0HJcxiwmxgxrBpyFLCLCbMBmaM52aVpYRZTJg1STwtJcyebLcCM4bF0zI7LkyYdek+U8IsJsy2hBUzo6+VUbgyJcxiwmxL2IIdMEqYxYTZIj1glDCLCbOBGctODEsJs5gwF5ix7MRwlDCHCXOBGctODEcJc5gwF5ix7MRwlDCHCXMmmfQdJcxhwly7o2dnlaOEuZNNvUtC4ph9PSbMBWYsf09ACXOYMBeYsew+zFHCHCbMBWYsO6scJcxhwtwiybajhDlMmJ8n2faUMI8J8y1h7HLjKWEeE+ZbwtjlxlPCPCbMm2Qm8ZQwjwnzNgmJp4R5TJh3ydTrKWH+5NYxMOPYZOCZu0dMmA/MODYZeEqYx4T5wIxjk4GnhHlMmA/MODYZeEqYx4TlgRnHzuecEpZjwvLAjGOnZE4JyzFhuU5CklPCckxYHphxbJxzSliOCcsDM46dzzklLMeE5e2TiYJ1poTlmLC8JYydVTklLD95QNE+oWDxzJlnFJiwvEgPGCUsx4Tli+QdXU4JyzFhxTx5R1dQwgpMWKGSd3QFJazAhBU6GaqCElZgwgqT7HNBCSswYYVN95kSVmDCCpfuMyUs/tQ+p3wu60O5+dg9r1wuuy+jXrK7+AQz7x+YvmRFdvPy+jo8r7x5eQWPLMO1YILOoA86w1djL5kyXV3tpIrxPACQM0DORjkvk0ud6xnULVB3WqTaf9k1iBSDxkIm0X7HOAiAERO2AX5oB8YKDFVXUzZQ3StE0B7YoKKr5IxMCh5GAOO8GBS9rI8cWwaEy8jGupfp3l0AKcC7tZOkdv2RO9C/OVCb1rD41gFogTC6uUjreIgA9M+CFglV+s8UAAlgwLWsX6cDrUBDlIsTOOKZL7p/Cxlcp1/jgt4CLqRS/YeIoKkgikqJdLpT/2DAAFZG1hR4Ag9QAIbNyfgcTgOAgXEAgzjqNkbBx+ycyyZk9xILSIO8Z33MEr20rMWh+iY9EUAacrJwhI+EBwE/1M9l1cHhQNAOMIZOllHxKT8gBZrkZG3q3oICSEFrVBx2reM8msd/ZcM/tjACjp1sPxDPTwFAQGdtbKGX7QTQ4UCgCJYRm0fkZGkpfggFZiqYYEaWIOPHqSAWoIdKFs7jxzqgJWAiGVnk8Ac3QAoMkJENddN/bz6oABElG5koQvdGCmjpaVrxPCVgEoyTl+WD1HoBEv2kRrVCYfv2PR7cGSQd6GkuyxJQlAp60MhcBlcUJPNGAyktIyxKMTsLB9Kyl6WGKFYdj/UBNbB0e9lU7tVONhoOTOh8UlS5hdOBNJtPgu2xQdRqsJ3Tk8JYH79GAxkQqJmL1LovzEBH4SrZ7wgmhZUs3A4sHvkk3J7bU01ACUz5PO4tCtl2pf0EFYQBxNMI43naLwX6peJ9kY5DVsTNVSHMuujsL+gwmKlemEXavzYAWgnGTAlnFLMXhjeTwhGPH2UCWkFvjLA3/dF8EDpAqIn7CBuH3cYweOGEb/8SDhhusMsRCZz+UR6wOoGtiUzqZCIakFeNbAIej3ODHoG4eUGCuJ1l+2pfPlTbMrtZ3r6+/h88aQN+"; \ No newline at end of file diff --git a/docs/services/classes/ServiceError.html b/docs/services/classes/ServiceError.html index 806dd290..e00d674b 100644 --- a/docs/services/classes/ServiceError.html +++ b/docs/services/classes/ServiceError.html @@ -4,12 +4,33 @@ message name stack? -prepareStackTrace? stackTraceLimit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  captureStackTrace isServiceError +prepareStackTrace toServiceError -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • code: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns ServiceError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cause?: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  code: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  message: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stack?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional override for formatting stack traces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stackTraceLimit: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Create .stack property on a target object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • targetObject: object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalconstructorOpt: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • msg: Msg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • code: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns ServiceError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cause?: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  code: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  message: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stack?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stackTraceLimit: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The default value is 10 but may be set to any valid JavaScript number. Changes +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 +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`
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • msg: Msg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/services/index.html b/docs/services/index.html index fef4ec75..e5e2a4e8 100644 --- a/docs/services/index.html +++ b/docs/services/index.html @@ -1,5 +1,5 @@ @nats-io/services
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @nats-io/services
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @nats-io/services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    License -jetstream +services JSDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    JSR JSR