@openstatus/health-tcp 0.1.4-dev.0 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/mod.cjs +1 -0
- package/dist/mod.js +1 -0
- package/dist/mod.js.map +1 -1
- package/package.json +2 -2
package/dist/mod.cjs
CHANGED
package/dist/mod.js
CHANGED
package/dist/mod.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mod.js","names":["options: TcpProbeOptions","connect","netConnect","finish: () => void"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * TCP probe for `@openstatus/health`: opens a socket to `host:port` and\n * closes it again, for any dependency without a client library.\n *\n * ```ts\n * import { tcpProbe } from \"@openstatus/health-tcp\";\n *\n * const probe = tcpProbe({ host: \"smtp.example.com\", port: 587 });\n * ```\n *\n * Node.js, Deno and Bun only: it uses `node:net`.\n *\n * @module\n */\n\nimport { connect as netConnect } from \"node:net\";\nimport {\n type Probe,\n ProbeConfigError,\n type ProbeOverrides,\n} from \"@openstatus/health\";\n\n/** Probe name when `name` is unset. */\nexport const tcpDefaultName = \"tcp\";\n\n/** The subset of a `net.Socket` the probe uses. */\nexport interface TcpLikeSocket {\n /** Listen once for `connect` (established) or `error` (failed). */\n once(\n event: \"connect\" | \"error\",\n listener: (error?: Error) => void,\n ): TcpLikeSocket;\n /** Close the socket. */\n destroy(): void;\n}\n\n/** What the probe connects with; `net.connect` by default. */\nexport type TcpConnect = (\n options: { readonly host: string; readonly port: number },\n) => TcpLikeSocket;\n\n/** Options for `tcpProbe()`. */\nexport interface TcpProbeOptions extends ProbeOverrides {\n /** Hostname or IP address. */\n readonly host: string;\n /** Port, 1–65535. */\n readonly port: number;\n /** Replacement `connect`, for tests. */\n readonly connect?: TcpConnect;\n}\n\n/** A probe that connects to `host:port`; non-critical by default. Throws `ProbeConfigError` for an empty `host` or an invalid `port`. */\nexport function tcpProbe(options: TcpProbeOptions): Probe {\n const { host, port } = options;\n if (typeof host !== \"string\" || host.length === 0) {\n throw new ProbeConfigError(\n \"tcpProbe\",\n \"host\",\n typeof host !== \"string\"\n ? `must be a string, got ${String(host)}`\n : \"must not be empty\",\n );\n }\n if (!Number.isInteger(port) || port < 1 || port > 65535) {\n throw new ProbeConfigError(\n \"tcpProbe\",\n \"port\",\n `must be an integer between 1 and 65535, got ${String(port)}`,\n );\n }\n const connect = options.connect ?? netConnect;\n return {\n name: options.name ?? tcpDefaultName,\n critical: options.critical ?? false,\n timeoutMs: options.timeoutMs,\n skip: options.skip,\n run: (signal) =>\n new Promise<void>((resolve, reject) => {\n const socket = connect({ host, port });\n const settle = (finish: () => void) => {\n signal.removeEventListener(\"abort\", onAbort);\n socket.destroy();\n finish();\n };\n const onAbort = () => settle(() => reject(signal.reason));\n socket.once(\"connect\", () => settle(resolve));\n socket.once(\n \"error\",\n (error) => settle(() => reject(error ?? new Error(\"socket error\"))),\n );\n signal.addEventListener(\"abort\", onAbort, { once: true });\n }),\n };\n}\n"],"mappings":";;;;;AAuBA,MAAa,iBAAiB;;AA6B9B,SAAgB,SAASA,SAAiC;CACxD,MAAM,EAAE,MAAM,MAAM,GAAG;AACvB,YAAW,SAAS,YAAY,KAAK,WAAW,EAC9C,OAAM,IAAI,iBACR,YACA,eACO,SAAS,YACX,wBAAwB,OAAO,KAAK,CAAC,IACtC;AAGR,MAAK,OAAO,UAAU,KAAK,IAAI,OAAO,KAAK,OAAO,MAChD,OAAM,IAAI,iBACR,YACA,SACC,8CAA8C,OAAO,KAAK,CAAC;CAGhE,MAAMC,YAAU,QAAQ,WAAWC;AACnC,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,CAAC,WACJ,IAAI,QAAc,CAAC,SAAS,WAAW;
|
|
1
|
+
{"version":3,"file":"mod.js","names":["options: TcpProbeOptions","connect","netConnect","finish: () => void"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * TCP probe for `@openstatus/health`: opens a socket to `host:port` and\n * closes it again, for any dependency without a client library.\n *\n * ```ts\n * import { tcpProbe } from \"@openstatus/health-tcp\";\n *\n * const probe = tcpProbe({ host: \"smtp.example.com\", port: 587 });\n * ```\n *\n * Node.js, Deno and Bun only: it uses `node:net`.\n *\n * @module\n */\n\nimport { connect as netConnect } from \"node:net\";\nimport {\n type Probe,\n ProbeConfigError,\n type ProbeOverrides,\n} from \"@openstatus/health\";\n\n/** Probe name when `name` is unset. */\nexport const tcpDefaultName = \"tcp\";\n\n/** The subset of a `net.Socket` the probe uses. */\nexport interface TcpLikeSocket {\n /** Listen once for `connect` (established) or `error` (failed). */\n once(\n event: \"connect\" | \"error\",\n listener: (error?: Error) => void,\n ): TcpLikeSocket;\n /** Close the socket. */\n destroy(): void;\n}\n\n/** What the probe connects with; `net.connect` by default. */\nexport type TcpConnect = (\n options: { readonly host: string; readonly port: number },\n) => TcpLikeSocket;\n\n/** Options for `tcpProbe()`. */\nexport interface TcpProbeOptions extends ProbeOverrides {\n /** Hostname or IP address. */\n readonly host: string;\n /** Port, 1–65535. */\n readonly port: number;\n /** Replacement `connect`, for tests. */\n readonly connect?: TcpConnect;\n}\n\n/** A probe that connects to `host:port`; non-critical by default. Throws `ProbeConfigError` for an empty `host` or an invalid `port`. */\nexport function tcpProbe(options: TcpProbeOptions): Probe {\n const { host, port } = options;\n if (typeof host !== \"string\" || host.length === 0) {\n throw new ProbeConfigError(\n \"tcpProbe\",\n \"host\",\n typeof host !== \"string\"\n ? `must be a string, got ${String(host)}`\n : \"must not be empty\",\n );\n }\n if (!Number.isInteger(port) || port < 1 || port > 65535) {\n throw new ProbeConfigError(\n \"tcpProbe\",\n \"port\",\n `must be an integer between 1 and 65535, got ${String(port)}`,\n );\n }\n const connect = options.connect ?? netConnect;\n return {\n name: options.name ?? tcpDefaultName,\n critical: options.critical ?? false,\n timeoutMs: options.timeoutMs,\n skip: options.skip,\n run: (signal) =>\n new Promise<void>((resolve, reject) => {\n signal.throwIfAborted();\n const socket = connect({ host, port });\n const settle = (finish: () => void) => {\n signal.removeEventListener(\"abort\", onAbort);\n socket.destroy();\n finish();\n };\n const onAbort = () => settle(() => reject(signal.reason));\n socket.once(\"connect\", () => settle(resolve));\n socket.once(\n \"error\",\n (error) => settle(() => reject(error ?? new Error(\"socket error\"))),\n );\n signal.addEventListener(\"abort\", onAbort, { once: true });\n }),\n };\n}\n"],"mappings":";;;;;AAuBA,MAAa,iBAAiB;;AA6B9B,SAAgB,SAASA,SAAiC;CACxD,MAAM,EAAE,MAAM,MAAM,GAAG;AACvB,YAAW,SAAS,YAAY,KAAK,WAAW,EAC9C,OAAM,IAAI,iBACR,YACA,eACO,SAAS,YACX,wBAAwB,OAAO,KAAK,CAAC,IACtC;AAGR,MAAK,OAAO,UAAU,KAAK,IAAI,OAAO,KAAK,OAAO,MAChD,OAAM,IAAI,iBACR,YACA,SACC,8CAA8C,OAAO,KAAK,CAAC;CAGhE,MAAMC,YAAU,QAAQ,WAAWC;AACnC,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,CAAC,WACJ,IAAI,QAAc,CAAC,SAAS,WAAW;AACrC,UAAO,gBAAgB;GACvB,MAAM,SAAS,UAAQ;IAAE;IAAM;GAAM,EAAC;GACtC,MAAM,SAAS,CAACC,WAAuB;AACrC,WAAO,oBAAoB,SAAS,QAAQ;AAC5C,WAAO,SAAS;AAChB,YAAQ;GACT;GACD,MAAM,UAAU,MAAM,OAAO,MAAM,OAAO,OAAO,OAAO,CAAC;AACzD,UAAO,KAAK,WAAW,MAAM,OAAO,QAAQ,CAAC;AAC7C,UAAO,KACL,SACA,CAAC,UAAU,OAAO,MAAM,OAAO,yBAAS,IAAI,MAAM,gBAAgB,CAAC,CACpE;AACD,UAAO,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAM,EAAC;EAC1D;CACJ;AACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openstatus/health-tcp",
|
|
3
|
-
"version": "0.1.4
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "TCP connect probe for @openstatus/health",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"openstatus",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"node": ">=22"
|
|
49
49
|
},
|
|
50
50
|
"peerDependencies": {
|
|
51
|
-
"@openstatus/health": "^0.1.4
|
|
51
|
+
"@openstatus/health": "^0.1.4"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
54
|
"@types/node": ">=22",
|