docs: fix and regenerate api docs

belgattitude · May 24, 2024 · 16e7dce · 16e7dce
1 parent 9af23c3
commit 16e7dce
Show file tree

Hide file tree

Showing 105 changed files with 271 additions and 271 deletions.
diff --git a/packages/assert/README.md b/packages/assert/README.md
@@ -292,11 +292,11 @@ assertStringNonEmpty(''); // 👉 throws
 
 
 ```typescript
-import { assertStrParsableSafeInt, isStrParsableSafeInt } from '@httpx/assert';
+import { assertParsableSafeInt, isParsableSafeInt } from '@httpx/assert';
 
-isStrParsableSafeInt(2); // 👉 false
-isStrParsableSafeInt(`${Number.MAX_SAFE_INTEGER}`); // 👉 true
-assertStrParsableSafeInt(`${Number.MAX_SAFE_INTEGER}1`); // 👉 throws
+isParsableSafeInt(2); // 👉 false
+isParsableSafeInt(`${Number.MAX_SAFE_INTEGER}`); // 👉 true
+assertParsableSafeInt(`${Number.MAX_SAFE_INTEGER}1`); // 👉 throws
 ```
 
 #### isParsableStrictIsoDateZ

diff --git a/packages/assert/docs/api/README.md b/packages/assert/docs/api/README.md
@@ -1,8 +1,8 @@
-**@httpx/assert v0.11.0** • **Docs**
+**@httpx/assert v0.12.1** • **Docs**
 
 ***
 
-# @httpx/assert v0.11.0
+# @httpx/assert v0.12.1
 
 ## Modules
 

diff --git a/packages/assert/docs/api/array.asserts/README.md b/packages/assert/docs/api/array.asserts/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / array.asserts
+[@httpx/assert v0.12.1](../README.md) / array.asserts
 
 # array.asserts
 

diff --git a/packages/assert/docs/api/array.asserts/functions/assertArrayNonEmpty.md b/packages/assert/docs/api/array.asserts/functions/assertArrayNonEmpty.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [array.asserts](../README.md) / assertArrayNonEmpty
+[@httpx/assert v0.12.1](../../README.md) / [array.asserts](../README.md) / assertArrayNonEmpty
 
 # Function: assertArrayNonEmpty()
 
@@ -30,4 +30,4 @@ TypeError
 
 ## Source
 
-[array.asserts.ts:10](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/array.asserts.ts#L10)
+[array.asserts.ts:10](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/array.asserts.ts#L10)
diff --git a/packages/assert/docs/api/array.guards/README.md b/packages/assert/docs/api/array.guards/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / array.guards
+[@httpx/assert v0.12.1](../README.md) / array.guards
 
 # array.guards
 

diff --git a/packages/assert/docs/api/array.guards/functions/isArrayNonEmpty.md b/packages/assert/docs/api/array.guards/functions/isArrayNonEmpty.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [array.guards](../README.md) / isArrayNonEmpty
+[@httpx/assert v0.12.1](../../README.md) / [array.guards](../README.md) / isArrayNonEmpty
 
 # Function: isArrayNonEmpty()
 
@@ -22,4 +22,4 @@
 
 ## Source
 
-[array.guards.ts:3](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/array.guards.ts#L3)
+[array.guards.ts:3](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/array.guards.ts#L3)
diff --git a/packages/assert/docs/api/array.types/README.md b/packages/assert/docs/api/array.types/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / array.types
+[@httpx/assert v0.12.1](../README.md) / array.types
 
 # array.types
 

diff --git a/packages/assert/docs/api/array.types/type-aliases/ArrayNonEmpty.md b/packages/assert/docs/api/array.types/type-aliases/ArrayNonEmpty.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [array.types](../README.md) / ArrayNonEmpty
+[@httpx/assert v0.12.1](../../README.md) / [array.types](../README.md) / ArrayNonEmpty
 
 # Type alias: ArrayNonEmpty\<T\>
 
@@ -14,4 +14,4 @@
 
 ## Source
 
-[array.types.ts:1](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/array.types.ts#L1)
+[array.types.ts:1](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/array.types.ts#L1)
diff --git a/packages/assert/docs/api/barcode.asserts/README.md b/packages/assert/docs/api/barcode.asserts/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / barcode.asserts
+[@httpx/assert v0.12.1](../README.md) / barcode.asserts
 
 # barcode.asserts
 

diff --git a/packages/assert/docs/api/barcode.asserts/functions/assertEan13.md b/packages/assert/docs/api/barcode.asserts/functions/assertEan13.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [barcode.asserts](../README.md) / assertEan13
+[@httpx/assert v0.12.1](../../README.md) / [barcode.asserts](../README.md) / assertEan13
 
 # Function: assertEan13()
 
@@ -26,4 +26,4 @@ TypeError
 
 ## Source
 
-[barcode.asserts.ts:10](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/barcode.asserts.ts#L10)
+[barcode.asserts.ts:10](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/barcode.asserts.ts#L10)
diff --git a/packages/assert/docs/api/barcode.guards/README.md b/packages/assert/docs/api/barcode.guards/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / barcode.guards
+[@httpx/assert v0.12.1](../README.md) / barcode.guards
 
 # barcode.guards
 

diff --git a/packages/assert/docs/api/barcode.guards/functions/isEan13.md b/packages/assert/docs/api/barcode.guards/functions/isEan13.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [barcode.guards](../README.md) / isEan13
+[@httpx/assert v0.12.1](../../README.md) / [barcode.guards](../README.md) / isEan13
 
 # Function: isEan13()
 
@@ -18,4 +18,4 @@
 
 ## Source
 
-[barcode.guards.ts:3](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/barcode.guards.ts#L3)
+[barcode.guards.ts:3](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/barcode.guards.ts#L3)
diff --git a/packages/assert/docs/api/barcode.types/README.md b/packages/assert/docs/api/barcode.types/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / barcode.types
+[@httpx/assert v0.12.1](../README.md) / barcode.types
 
 # barcode.types
 

diff --git a/packages/assert/docs/api/barcode.types/type-aliases/Ean13.md b/packages/assert/docs/api/barcode.types/type-aliases/Ean13.md
@@ -1,13 +1,13 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [barcode.types](../README.md) / Ean13
+[@httpx/assert v0.12.1](../../README.md) / [barcode.types](../README.md) / Ean13
 
 # Type alias: Ean13
 
 > **Ean13**: `string` & `WeakOpaqueContainer`\<`"Ean13"`\>
 
 ## Source
 
-[barcode.types.ts:3](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/barcode.types.ts#L3)
+[barcode.types.ts:3](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/barcode.types.ts#L3)
diff --git a/packages/assert/docs/api/http.asserts/README.md b/packages/assert/docs/api/http.asserts/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / http.asserts
+[@httpx/assert v0.12.1](../README.md) / http.asserts
 
 # http.asserts
 

diff --git a/packages/assert/docs/api/http.asserts/functions/assertHttpMethod.md b/packages/assert/docs/api/http.asserts/functions/assertHttpMethod.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [http.asserts](../README.md) / assertHttpMethod
+[@httpx/assert v0.12.1](../../README.md) / [http.asserts](../README.md) / assertHttpMethod
 
 # Function: assertHttpMethod()
 
@@ -30,4 +30,4 @@ TypeError
 
 ## Source
 
-[http.asserts.ts:25](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/http.asserts.ts#L25)
+[http.asserts.ts:25](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/http.asserts.ts#L25)
diff --git a/packages/assert/docs/api/http.asserts/functions/assertHttpValidMethod.md b/packages/assert/docs/api/http.asserts/functions/assertHttpValidMethod.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [http.asserts](../README.md) / assertHttpValidMethod
+[@httpx/assert v0.12.1](../../README.md) / [http.asserts](../README.md) / assertHttpValidMethod
 
 # Function: assertHttpValidMethod()
 
@@ -26,4 +26,4 @@ TypeError
 
 ## Source
 
-[http.asserts.ts:10](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/http.asserts.ts#L10)
+[http.asserts.ts:10](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/http.asserts.ts#L10)
diff --git a/packages/assert/docs/api/http.consts/README.md b/packages/assert/docs/api/http.consts/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / http.consts
+[@httpx/assert v0.12.1](../README.md) / http.consts
 
 # http.consts
 

diff --git a/packages/assert/docs/api/http.consts/variables/httpMethods.md b/packages/assert/docs/api/http.consts/variables/httpMethods.md
@@ -1,13 +1,13 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [http.consts](../README.md) / httpMethods
+[@httpx/assert v0.12.1](../../README.md) / [http.consts](../README.md) / httpMethods
 
 # Variable: httpMethods
 
 > `const` **httpMethods**: readonly [`"GET"`, `"POST"`, `"HEAD"`, `"PUT"`, `"DELETE"`, `"CONNECT"`, `"OPTIONS"`, `"PATCH"`, `"TRACE"`]
 
 ## Source
 
-[http.consts.ts:1](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/http.consts.ts#L1)
+[http.consts.ts:1](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/http.consts.ts#L1)
diff --git a/packages/assert/docs/api/http.guards/README.md b/packages/assert/docs/api/http.guards/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / http.guards
+[@httpx/assert v0.12.1](../README.md) / http.guards
 
 # http.guards
 

diff --git a/packages/assert/docs/api/http.guards/functions/isHttpMethod.md b/packages/assert/docs/api/http.guards/functions/isHttpMethod.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [http.guards](../README.md) / isHttpMethod
+[@httpx/assert v0.12.1](../../README.md) / [http.guards](../README.md) / isHttpMethod
 
 # Function: isHttpMethod()
 
@@ -24,4 +24,4 @@
 
 ## Source
 
-[http.guards.ts:15](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/http.guards.ts#L15)
+[http.guards.ts:15](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/http.guards.ts#L15)
diff --git a/packages/assert/docs/api/http.guards/functions/isHttpValidMethod.md b/packages/assert/docs/api/http.guards/functions/isHttpValidMethod.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [http.guards](../README.md) / isHttpValidMethod
+[@httpx/assert v0.12.1](../../README.md) / [http.guards](../README.md) / isHttpValidMethod
 
 # Function: isHttpValidMethod()
 
@@ -21,4 +21,4 @@ a case-insensitive manner.
 
 ## Source
 
-[http.guards.ts:8](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/http.guards.ts#L8)
+[http.guards.ts:8](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/http.guards.ts#L8)
diff --git a/packages/assert/docs/api/http.types/README.md b/packages/assert/docs/api/http.types/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / http.types
+[@httpx/assert v0.12.1](../README.md) / http.types
 
 # http.types
 

diff --git a/packages/assert/docs/api/http.types/type-aliases/HttpMethod.md b/packages/assert/docs/api/http.types/type-aliases/HttpMethod.md
@@ -1,13 +1,13 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [http.types](../README.md) / HttpMethod
+[@httpx/assert v0.12.1](../../README.md) / [http.types](../README.md) / HttpMethod
 
 # Type alias: HttpMethod
 
 > **HttpMethod**: `"GET"` \| `"POST"` \| `"HEAD"` \| `"PUT"` \| `"DELETE"` \| `"CONNECT"` \| `"OPTIONS"` \| `"PATCH"` \| `"TRACE"`
 
 ## Source
 
-[http.types.ts:1](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/http.types.ts#L1)
+[http.types.ts:1](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/http.types.ts#L1)
diff --git a/packages/assert/docs/api/index/README.md b/packages/assert/docs/api/index/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / index
+[@httpx/assert v0.12.1](../README.md) / index
 
 # index
 

diff --git a/packages/assert/docs/api/network.asserts/README.md b/packages/assert/docs/api/network.asserts/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / network.asserts
+[@httpx/assert v0.12.1](../README.md) / network.asserts
 
 # network.asserts
 

diff --git a/packages/assert/docs/api/network.asserts/functions/assertNetworkPort.md b/packages/assert/docs/api/network.asserts/functions/assertNetworkPort.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../../README.md) / [network.asserts](../README.md) / assertNetworkPort
+[@httpx/assert v0.12.1](../../README.md) / [network.asserts](../README.md) / assertNetworkPort
 
 # Function: assertNetworkPort()
 
@@ -24,4 +24,4 @@ TypeError
 
 ## Source
 
-[network.asserts.ts:9](https://github.com/belgattitude/httpx/blob/87fb49862cf7e06acc8e0c35f7b115413ff3c6fe/packages/assert/src/network.asserts.ts#L9)
+[network.asserts.ts:9](https://github.com/belgattitude/httpx/blob/9af23c30700a45e9eb95108b7ac53f133f16092b/packages/assert/src/network.asserts.ts#L9)
diff --git a/packages/assert/docs/api/network.guards/README.md b/packages/assert/docs/api/network.guards/README.md
@@ -1,8 +1,8 @@
-[**@httpx/assert v0.11.0**](../README.md) • **Docs**
+[**@httpx/assert v0.12.1**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.11.0](../README.md) / network.guards
+[@httpx/assert v0.12.1](../README.md) / network.guards
 
 # network.guards