From 4190a51c09b6906f9fe22cb6e4473fde8e18081f Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Tue, 17 Dec 2024 16:20:40 +0000 Subject: [PATCH] chore(release): 1.8.0 [skip ci] MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## [1.8.0](https://github.com/SkeLLLa/pinot-noir/compare/v1.7.0...v1.8.0) (2024-12-17) ### 🚀 Features * add header and connect timeouts ([6183474](https://github.com/SkeLLLa/pinot-noir/commit/6183474786c3c516651f176392725c9462b8bbe9)) * undici v7 ([4c5f2de](https://github.com/SkeLLLa/pinot-noir/commit/4c5f2dee72e714c0a224564a8f687cafef439520)) ### 📔 Docs * fix badge ([e6b831a](https://github.com/SkeLLLa/pinot-noir/commit/e6b831ac76d692143b0808a0c944fad0b59b2840)) --- docs/CHANGELOG.md | 11 ++++++ .../pinot-noir.ebrokertransporterrorcode.md | 13 +++++++ ...noir.ibrokertransportconfig.bodytimeout.md | 2 +- ...r.ibrokertransportconfig.connecttimeout.md | 13 +++++++ ...r.ibrokertransportconfig.headerstimeout.md | 13 +++++++ ...okertransportconfig.keepalivemaxtimeout.md | 2 +- docs/api/pinot-noir.ibrokertransportconfig.md | 34 +++++++++++++++++-- ....pinotbrokerjsontransport._constructor_.md | 4 +-- .../pinot-noir.pinotbrokerjsontransport.md | 4 +-- ...t-noir.pinotbrokerjsontransport.request.md | 4 +-- package.json | 2 +- 11 files changed, 91 insertions(+), 11 deletions(-) create mode 100644 docs/api/pinot-noir.ibrokertransportconfig.connecttimeout.md create mode 100644 docs/api/pinot-noir.ibrokertransportconfig.headerstimeout.md diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index b514c6c..36799d7 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,3 +1,14 @@ +## [1.8.0](https://github.com/SkeLLLa/pinot-noir/compare/v1.7.0...v1.8.0) (2024-12-17) + +### 🚀 Features + +* add header and connect timeouts ([6183474](https://github.com/SkeLLLa/pinot-noir/commit/6183474786c3c516651f176392725c9462b8bbe9)) +* undici v7 ([4c5f2de](https://github.com/SkeLLLa/pinot-noir/commit/4c5f2dee72e714c0a224564a8f687cafef439520)) + +### 📔 Docs + +* fix badge ([e6b831a](https://github.com/SkeLLLa/pinot-noir/commit/e6b831ac76d692143b0808a0c944fad0b59b2840)) + ## [1.7.0](https://github.com/SkeLLLa/pinot-noir/compare/v1.6.0...v1.7.0) (2024-09-17) ### 🛠 Fixes diff --git a/docs/api/pinot-noir.ebrokertransporterrorcode.md b/docs/api/pinot-noir.ebrokertransporterrorcode.md index 00bab63..5c0805a 100644 --- a/docs/api/pinot-noir.ebrokertransporterrorcode.md +++ b/docs/api/pinot-noir.ebrokertransporterrorcode.md @@ -42,6 +42,19 @@ Invalid response from pinot +TIMEOUT + + + +`2` + + + +Timeout + + + + UNKNOWN diff --git a/docs/api/pinot-noir.ibrokertransportconfig.bodytimeout.md b/docs/api/pinot-noir.ibrokertransportconfig.bodytimeout.md index 204263f..ea3098d 100644 --- a/docs/api/pinot-noir.ibrokertransportconfig.bodytimeout.md +++ b/docs/api/pinot-noir.ibrokertransportconfig.bodytimeout.md @@ -4,7 +4,7 @@ ## IBrokerTransportConfig.bodyTimeout property -The timeout after which a request will time out, in milliseconds +The timeout after which a request will time out (in ms) **Signature:** diff --git a/docs/api/pinot-noir.ibrokertransportconfig.connecttimeout.md b/docs/api/pinot-noir.ibrokertransportconfig.connecttimeout.md new file mode 100644 index 0000000..4f9f8e9 --- /dev/null +++ b/docs/api/pinot-noir.ibrokertransportconfig.connecttimeout.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [pinot-noir](./pinot-noir.md) > [IBrokerTransportConfig](./pinot-noir.ibrokertransportconfig.md) > [connectTimeout](./pinot-noir.ibrokertransportconfig.connecttimeout.md) + +## IBrokerTransportConfig.connectTimeout property + +TCP connect timeout (in ms) + +**Signature:** + +```typescript +connectTimeout?: number; +``` diff --git a/docs/api/pinot-noir.ibrokertransportconfig.headerstimeout.md b/docs/api/pinot-noir.ibrokertransportconfig.headerstimeout.md new file mode 100644 index 0000000..4dcac9e --- /dev/null +++ b/docs/api/pinot-noir.ibrokertransportconfig.headerstimeout.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [pinot-noir](./pinot-noir.md) > [IBrokerTransportConfig](./pinot-noir.ibrokertransportconfig.md) > [headersTimeout](./pinot-noir.ibrokertransportconfig.headerstimeout.md) + +## IBrokerTransportConfig.headersTimeout property + +Headers timeout (in ms) + +**Signature:** + +```typescript +headersTimeout?: number; +``` diff --git a/docs/api/pinot-noir.ibrokertransportconfig.keepalivemaxtimeout.md b/docs/api/pinot-noir.ibrokertransportconfig.keepalivemaxtimeout.md index 2cd2625..fc794d7 100644 --- a/docs/api/pinot-noir.ibrokertransportconfig.keepalivemaxtimeout.md +++ b/docs/api/pinot-noir.ibrokertransportconfig.keepalivemaxtimeout.md @@ -4,7 +4,7 @@ ## IBrokerTransportConfig.keepAliveMaxTimeout property -The maximum allowed `keepAliveTimeout` +The maximum allowed `keepAliveTimeout` (in ms) **Signature:** diff --git a/docs/api/pinot-noir.ibrokertransportconfig.md b/docs/api/pinot-noir.ibrokertransportconfig.md index d0b916f..cf8a9d3 100644 --- a/docs/api/pinot-noir.ibrokertransportconfig.md +++ b/docs/api/pinot-noir.ibrokertransportconfig.md @@ -43,7 +43,7 @@ number -_(Optional)_ The timeout after which a request will time out, in milliseconds +_(Optional)_ The timeout after which a request will time out (in ms) @@ -78,6 +78,36 @@ _(Optional)_ Max pool connections. `undefined` = unlimited. +[connectTimeout?](./pinot-noir.ibrokertransportconfig.connecttimeout.md) + + + + + +number + + + +_(Optional)_ TCP connect timeout (in ms) + + + + +[headersTimeout?](./pinot-noir.ibrokertransportconfig.headerstimeout.md) + + + + + +number + + + +_(Optional)_ Headers timeout (in ms) + + + + [keepAliveMaxTimeout?](./pinot-noir.ibrokertransportconfig.keepalivemaxtimeout.md) @@ -88,7 +118,7 @@ number -_(Optional)_ The maximum allowed `keepAliveTimeout` +_(Optional)_ The maximum allowed `keepAliveTimeout` (in ms) diff --git a/docs/api/pinot-noir.pinotbrokerjsontransport._constructor_.md b/docs/api/pinot-noir.pinotbrokerjsontransport._constructor_.md index 1b2b897..075375a 100644 --- a/docs/api/pinot-noir.pinotbrokerjsontransport._constructor_.md +++ b/docs/api/pinot-noir.pinotbrokerjsontransport._constructor_.md @@ -9,7 +9,7 @@ Constructs a new instance of the `PinotBrokerJSONTransport` class **Signature:** ```typescript -constructor({ brokerUrl, token, bodyTimeout, connections, keepAliveMaxTimeout, }: IBrokerTransportConfig); +constructor({ bodyTimeout, brokerUrl, connections, connectTimeout, headersTimeout, keepAliveMaxTimeout, token, }: IBrokerTransportConfig); ``` ## Parameters @@ -29,7 +29,7 @@ Description -{ brokerUrl, token, bodyTimeout, connections, keepAliveMaxTimeout, } +{ bodyTimeout, brokerUrl, connections, connectTimeout, headersTimeout, keepAliveMaxTimeout, token, } diff --git a/docs/api/pinot-noir.pinotbrokerjsontransport.md b/docs/api/pinot-noir.pinotbrokerjsontransport.md index 2d85bdf..e3ba32f 100644 --- a/docs/api/pinot-noir.pinotbrokerjsontransport.md +++ b/docs/api/pinot-noir.pinotbrokerjsontransport.md @@ -31,7 +31,7 @@ Description -[(constructor)({ brokerUrl, token, bodyTimeout, connections, keepAliveMaxTimeout, })](./pinot-noir.pinotbrokerjsontransport._constructor_.md) +[(constructor)({ bodyTimeout, brokerUrl, connections, connectTimeout, headersTimeout, keepAliveMaxTimeout, token, })](./pinot-noir.pinotbrokerjsontransport._constructor_.md) @@ -142,7 +142,7 @@ Closes connection to pinot broker -[request({ method, headers, path, body, query, })](./pinot-noir.pinotbrokerjsontransport.request.md) +[request({ body, headers, method, path, query, })](./pinot-noir.pinotbrokerjsontransport.request.md) diff --git a/docs/api/pinot-noir.pinotbrokerjsontransport.request.md b/docs/api/pinot-noir.pinotbrokerjsontransport.request.md index e451303..b904f5f 100644 --- a/docs/api/pinot-noir.pinotbrokerjsontransport.request.md +++ b/docs/api/pinot-noir.pinotbrokerjsontransport.request.md @@ -9,7 +9,7 @@ Perform HTTP request to pinot **Signature:** ```typescript -request({ method, headers, path, body, query, }: IBrokerTransportRequestOptions): Promise; +request({ body, headers, method, path, query, }: IBrokerTransportRequestOptions): Promise; ``` ## Parameters @@ -29,7 +29,7 @@ Description -{ method, headers, path, body, query, } +{ body, headers, method, path, query, } diff --git a/package.json b/package.json index e045780..e32736b 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "$schema": "http://json.schemastore.org/package.json", "name": "pinot-noir", - "version": "1.7.0", + "version": "1.8.0", "description": "Unofficial client for Apache Pinot.", "keywords": [ "pinot",