Fix readme links (#1371)

* docs: regenerate * docs: changeset
belgattitude · Aug 20, 2024 · bda9fa3 · bda9fa3
1 parent 9d56eb5
commit bda9fa3
Show file tree

Hide file tree

Showing 121 changed files with 321 additions and 311 deletions.
diff --git a/.changeset/fair-eels-punch.md b/.changeset/fair-eels-punch.md
@@ -0,0 +1,5 @@
+---
+"@httpx/plain-object": patch
+---
+
+Fix readme links
diff --git a/docs/src/pages/plain-object.mdx b/docs/src/pages/plain-object.mdx
@@ -1,7 +1,8 @@
 import { Tabs, Tab } from 'nextra/components';
 
 <div className={'shadow-md -ml-2 mt-[30px] mb-[5px] border p-5 rounded '}>
-    Fast and lightweight utility functions to check if a value is a plain object.
+    [Fast](#benchmarks) and lightweight ([~100B](#bundle-size)) functions to check or assert
+    that a value is a plain object.
 </div>
 
 ## Install
@@ -37,7 +38,6 @@ import { Tabs, Tab } from 'nextra/components';
     </Tab>
 </Tabs>
 
-
 ## Features
 
 - 👉&nbsp; Provide [isPlainObject](#isplainobject) and [assertPlainObject](#assertplainobject) functions.
@@ -182,25 +182,27 @@ someFn(value)
 > [![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/belgattitude/httpx)
 
 ```
- RUN  v1.6.0 /home/sebastien/github/httpx/packages/plain-object
+ RUN  v2.0.5 /home/sebastien/github/httpx/packages/plain-object
 
- ✓ bench/comparative.bench.ts (5) 4047ms
-   ✓ Compare calling isPlainObject with 100x mixed types values (5) 4045ms
+ ✓ bench/comparative.bench.ts (6) 4778ms
+   ✓ Compare calling isPlainObject with 100x mixed types values (6) 4779ms
      name                                                           hz     min      max    mean     p75     p99    p995    p999     rme  samples
-   · @httpx/plain-object: `isPlainObject(v)`              1,589,546.49  0.0005   1.6911  0.0006  0.0006  0.0014  0.0017  0.0020  ±1.15%   794774   fastest
-   · (sindresorhus/)is-plain-obj: `isPlainObj(v)`         1,507,605.11  0.0005  10.7602  0.0007  0.0006  0.0010  0.0013  0.0018  ±4.90%   753803
-   · @sindresorhus/is: `is.plainObject(v)`                1,017,146.17  0.0008   5.0308  0.0010  0.0010  0.0015  0.0017  0.0081  ±2.22%   508574
-   · (jonschlinkert/)is-plain-object: `isPlainObject(v)`    687,342.39  0.0012  10.6447  0.0015  0.0014  0.0029  0.0031  0.0066  ±4.47%   343672
-   · lodash-es: `_.isPlainObject(v)`                         23,978.39  0.0364   5.9386  0.0417  0.0407  0.0875  0.1096  0.3677  ±2.50%    11990   slowest
+   · @httpx/plain-object: `isPlainObject(v)`              1,494,047.57  0.0005   8.3748  0.0007  0.0007  0.0008  0.0009  0.0047  ±3.40%   747024   fastest
+   · (sindresorhus/)is-plain-obj: `isPlainObj(v)`         1,314,933.16  0.0005  11.7854  0.0008  0.0007  0.0014  0.0015  0.0022  ±6.83%   657467
+   · @sindresorhus/is: `is.plainObject(v)`                  934,442.37  0.0009   2.1268  0.0011  0.0011  0.0015  0.0018  0.0065  ±1.38%   467222
+   · estoolkit:  `isPlainObject(v)`                         378,403.92  0.0020  10.3395  0.0026  0.0026  0.0035  0.0055  0.0155  ±4.23%   189202
+   · (jonschlinkert/)is-plain-object: `isPlainObject(v)`    629,387.99  0.0012  13.2170  0.0016  0.0015  0.0023  0.0030  0.0129  ±6.81%   314694
+   · lodash-es: `_.isPlainObject(v)`                         21,164.79  0.0361  11.2577  0.0472  0.0446  0.1057  0.1678  0.5020  ±5.03%    10583   slowest
 
 
  BENCH  Summary
 
   @httpx/plain-object: `isPlainObject(v)` - bench/comparative.bench.ts > Compare calling isPlainObject with 100x mixed types values
-    1.05x faster than (sindresorhus/)is-plain-obj: `isPlainObj(v)`
-    1.56x faster than @sindresorhus/is: `is.plainObject(v)`
-    2.31x faster than (jonschlinkert/)is-plain-object: `isPlainObject(v)`
-    66.29x faster than lodash-es: `_.isPlainObject(v)`
+    1.14x faster than (sindresorhus/)is-plain-obj: `isPlainObj(v)`
+    1.60x faster than @sindresorhus/is: `is.plainObject(v)`
+    2.37x faster than (jonschlinkert/)is-plain-object: `isPlainObject(v)`
+    3.95x faster than estoolkit:  `isPlainObject(v)`
+    70.59x faster than lodash-es: `_.isPlainObject(v)`
 
 ```
 
@@ -232,6 +234,7 @@ Bundle size is tracked by a [size-limit configuration](https://github.com/belgat
 
 > For _older_ browsers: most frontend frameworks can transpile the library (ie: [nextjs](https://nextjs.org/docs/app/api-reference/next-config-js/transpilePackages)...)
 
+
 ## Credits
 
 This library wouldn't be possible without [@sindresorhus](https://github.com/sindresorhus) [is-plain-obj](https://github.com/sindresorhus/is-plain-obj).
@@ -243,3 +246,5 @@ It passes the same test suite and should be 100% compatible with it. Notable dif
 - [x] Typescript convenience `PlainObject` type.
 - [x] ESM and CJS formats.
 
+
+
diff --git a/packages/assert/docs/api/README.md b/packages/assert/docs/api/README.md
@@ -1,8 +1,8 @@
-**@httpx/assert v0.12.3** • **Docs**
+**@httpx/assert v0.12.4** • **Docs**
 
 ***
 
-# @httpx/assert v0.12.3
+# @httpx/assert v0.12.4
 
 ## 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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / array.asserts
+[@httpx/assert v0.12.4](../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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [array.asserts](../README.md) / assertArrayNonEmpty
+[@httpx/assert v0.12.4](../../README.md) / [array.asserts](../README.md) / assertArrayNonEmpty
 
 # Function: assertArrayNonEmpty()
 
@@ -30,4 +30,4 @@ TypeError
 
 ## Defined in
 
-[array.asserts.ts:10](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/array.asserts.ts#L10)
+[array.asserts.ts:10](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / array.guards
+[@httpx/assert v0.12.4](../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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [array.guards](../README.md) / isArrayNonEmpty
+[@httpx/assert v0.12.4](../../README.md) / [array.guards](../README.md) / isArrayNonEmpty
 
 # Function: isArrayNonEmpty()
 
@@ -22,4 +22,4 @@
 
 ## Defined in
 
-[array.guards.ts:3](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/array.guards.ts#L3)
+[array.guards.ts:3](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / array.types
+[@httpx/assert v0.12.4](../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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [array.types](../README.md) / ArrayNonEmpty
+[@httpx/assert v0.12.4](../../README.md) / [array.types](../README.md) / ArrayNonEmpty
 
 # Type Alias: ArrayNonEmpty\<T\>
 
@@ -14,4 +14,4 @@
 
 ## Defined in
 
-[array.types.ts:1](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/array.types.ts#L1)
+[array.types.ts:1](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / barcode.asserts
+[@httpx/assert v0.12.4](../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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [barcode.asserts](../README.md) / assertEan13
+[@httpx/assert v0.12.4](../../README.md) / [barcode.asserts](../README.md) / assertEan13
 
 # Function: assertEan13()
 
@@ -26,4 +26,4 @@ TypeError
 
 ## Defined in
 
-[barcode.asserts.ts:10](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/barcode.asserts.ts#L10)
+[barcode.asserts.ts:10](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / barcode.guards
+[@httpx/assert v0.12.4](../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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [barcode.guards](../README.md) / isEan13
+[@httpx/assert v0.12.4](../../README.md) / [barcode.guards](../README.md) / isEan13
 
 # Function: isEan13()
 
@@ -18,4 +18,4 @@
 
 ## Defined in
 
-[barcode.guards.ts:3](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/barcode.guards.ts#L3)
+[barcode.guards.ts:3](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / barcode.types
+[@httpx/assert v0.12.4](../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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [barcode.types](../README.md) / Ean13
+[@httpx/assert v0.12.4](../../README.md) / [barcode.types](../README.md) / Ean13
 
 # Type Alias: Ean13
 
 > **Ean13**: `string` & `WeakOpaqueContainer`\<`"Ean13"`\>
 
 ## Defined in
 
-[barcode.types.ts:3](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/barcode.types.ts#L3)
+[barcode.types.ts:3](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / http.asserts
+[@httpx/assert v0.12.4](../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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [http.asserts](../README.md) / assertHttpMethod
+[@httpx/assert v0.12.4](../../README.md) / [http.asserts](../README.md) / assertHttpMethod
 
 # Function: assertHttpMethod()
 
@@ -30,4 +30,4 @@ TypeError
 
 ## Defined in
 
-[http.asserts.ts:25](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/http.asserts.ts#L25)
+[http.asserts.ts:25](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [http.asserts](../README.md) / assertHttpValidMethod
+[@httpx/assert v0.12.4](../../README.md) / [http.asserts](../README.md) / assertHttpValidMethod
 
 # Function: assertHttpValidMethod()
 
@@ -26,4 +26,4 @@ TypeError
 
 ## Defined in
 
-[http.asserts.ts:10](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/http.asserts.ts#L10)
+[http.asserts.ts:10](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / http.consts
+[@httpx/assert v0.12.4](../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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [http.consts](../README.md) / httpMethods
+[@httpx/assert v0.12.4](../../README.md) / [http.consts](../README.md) / httpMethods
 
 # Variable: httpMethods
 
 > `const` **httpMethods**: readonly [`"GET"`, `"POST"`, `"HEAD"`, `"PUT"`, `"DELETE"`, `"CONNECT"`, `"OPTIONS"`, `"PATCH"`, `"TRACE"`]
 
 ## Defined in
 
-[http.consts.ts:1](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/http.consts.ts#L1)
+[http.consts.ts:1](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / http.guards
+[@httpx/assert v0.12.4](../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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [http.guards](../README.md) / isHttpMethod
+[@httpx/assert v0.12.4](../../README.md) / [http.guards](../README.md) / isHttpMethod
 
 # Function: isHttpMethod()
 
@@ -24,4 +24,4 @@
 
 ## Defined in
 
-[http.guards.ts:15](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/http.guards.ts#L15)
+[http.guards.ts:15](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../../README.md) / [http.guards](../README.md) / isHttpValidMethod
+[@httpx/assert v0.12.4](../../README.md) / [http.guards](../README.md) / isHttpValidMethod
 
 # Function: isHttpValidMethod()
 
@@ -21,4 +21,4 @@ a case-insensitive manner.
 
 ## Defined in
 
-[http.guards.ts:8](https://github.com/belgattitude/httpx/blob/efdc4c7f5d90eb963a8ba204526e9494bbd080b8/packages/assert/src/http.guards.ts#L8)
+[http.guards.ts:8](https://github.com/belgattitude/httpx/blob/9d56eb57739de47a2eced4122ffa042138007013/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.12.3**](../README.md) • **Docs**
+[**@httpx/assert v0.12.4**](../README.md) • **Docs**
 
 ***
 
-[@httpx/assert v0.12.3](../README.md) / http.types
+[@httpx/assert v0.12.4](../README.md) / http.types
 
 # http.types