Weak opaque types (#847)

* feat: add weak opaque types * feat: add weak opaque types * feat: add weak opaque types
belgattitude · Jan 1, 2024 · 6b3f2d6 · 6b3f2d6
1 parent e508ebe
commit 6b3f2d6
Show file tree

Hide file tree

Showing 37 changed files with 204 additions and 102 deletions.
diff --git a/.changeset/fast-icons-notice.md b/.changeset/fast-icons-notice.md
@@ -0,0 +1,5 @@
+---
+"@httpx/assert": minor
+---
+
+Ass weak opaque type support for primitive types
diff --git a/packages/assert/docs/api/modules/array_asserts.md b/packages/assert/docs/api/modules/array_asserts.md
@@ -12,7 +12,7 @@
 
 ### assertArrayNonEmpty
 
-▸ **assertArrayNonEmpty**\<`T`\>(`v`, `msgOrErrorFactory?`): asserts v is ArrayNoNEmpty\<T\>
+▸ **assertArrayNonEmpty**\<`T`\>(`v`, `msgOrErrorFactory?`): asserts v is ArrayNonEmpty\<T\>
 
 Assert string is not empty (trims the string by default)
 
@@ -31,7 +31,7 @@ Assert string is not empty (trims the string by default)
 
 #### Returns
 
-asserts v is ArrayNoNEmpty\<T\>
+asserts v is ArrayNonEmpty\<T\>
 
 **`Throws`**
 

diff --git a/packages/assert/docs/api/modules/array_guards.md b/packages/assert/docs/api/modules/array_guards.md
@@ -12,7 +12,7 @@
 
 ### isArrayNonEmpty
 
-▸ **isArrayNonEmpty**\<`T`\>(`v`): v is ArrayNoNEmpty\<T\>
+▸ **isArrayNonEmpty**\<`T`\>(`v`): v is ArrayNonEmpty\<T\>
 
 #### Type parameters
 
@@ -28,4 +28,4 @@
 
 #### Returns
 
-v is ArrayNoNEmpty\<T\>
+v is ArrayNonEmpty\<T\>
diff --git a/packages/assert/docs/api/modules/array_types.md b/packages/assert/docs/api/modules/array_types.md
@@ -6,16 +6,16 @@
 
 ### Type Aliases
 
-- [ArrayNoNEmpty](array_types.md#arraynonempty)
+- [ArrayNonEmpty](array_types.md#arraynonempty)
 
 ## Type Aliases
 
-### ArrayNoNEmpty
+### ArrayNonEmpty
 
-Ƭ **ArrayNoNEmpty**\<`T`\>: [`T`, ...T[]]
+Ƭ **ArrayNonEmpty**\<`T`\>: [`T`, ...T[]]
 
 #### Type parameters
 
-| Name |
-| :------ |
-| `T` |
+| Name | Type |
+| :------ | :------ |
+| `T` | `unknown` |
diff --git a/packages/assert/docs/api/modules/barcode_asserts.md b/packages/assert/docs/api/modules/barcode_asserts.md
@@ -12,7 +12,7 @@
 
 ### assertEan13
 
-▸ **assertEan13**(`v`, `msgOrErrorFactory?`): asserts v is string
+▸ **assertEan13**(`v`, `msgOrErrorFactory?`): asserts v is Ean13
 
 Assert string is not empty (trims the string by default)
 
@@ -25,7 +25,7 @@ Assert string is not empty (trims the string by default)
 
 #### Returns
 
-asserts v is string
+asserts v is Ean13
 
 **`Throws`**
 

diff --git a/packages/assert/docs/api/modules/barcode_guards.md b/packages/assert/docs/api/modules/barcode_guards.md
@@ -12,7 +12,7 @@
 
 ### isEan13
 
-▸ **isEan13**(`v`): v is string
+▸ **isEan13**(`v`): v is Ean13
 
 #### Parameters
 
@@ -22,4 +22,4 @@
 
 #### Returns
 
-v is string
+v is Ean13
diff --git a/packages/assert/docs/api/modules/barcode_types.md b/packages/assert/docs/api/modules/barcode_types.md
@@ -12,4 +12,4 @@
 
 ### Ean13
 
-Ƭ **Ean13**: `string`
+Ƭ **Ean13**: `string` & `WeakOpaqueContainer`\<``"Ean13"``\>
diff --git a/packages/assert/docs/api/modules/index.md b/packages/assert/docs/api/modules/index.md
@@ -6,7 +6,7 @@
 
 ### References
 
-- [ArrayNoNEmpty](index.md#arraynonempty)
+- [ArrayNonEmpty](index.md#arraynonempty)
 - [Ean13](index.md#ean13)
 - [NumberSafeInt](index.md#numbersafeint)
 - [ParsableSafeInt](index.md#parsablesafeint)
@@ -53,9 +53,9 @@
 
 ## References
 
-### ArrayNoNEmpty
+### ArrayNonEmpty
 
-Re-exports [ArrayNoNEmpty](array_types.md#arraynonempty)
+Re-exports [ArrayNonEmpty](array_types.md#arraynonempty)
 
 ___
 

diff --git a/packages/assert/docs/api/modules/number_asserts.md b/packages/assert/docs/api/modules/number_asserts.md
@@ -12,7 +12,7 @@
 
 ### assertNumberSafeInt
 
-▸ **assertNumberSafeInt**(`v`, `msgOrErrorFactory?`): asserts v is number
+▸ **assertNumberSafeInt**(`v`, `msgOrErrorFactory?`): asserts v is NumberSafeInt
 
 Assert string is not empty (trims the string by default)
 
@@ -25,7 +25,7 @@ Assert string is not empty (trims the string by default)
 
 #### Returns
 
-asserts v is number
+asserts v is NumberSafeInt
 
 **`Throws`**
 

diff --git a/packages/assert/docs/api/modules/number_guards.md b/packages/assert/docs/api/modules/number_guards.md
@@ -12,7 +12,7 @@
 
 ### isNumberSafeInt
 
-▸ **isNumberSafeInt**\<`T`\>(`v`): v is ArrayNoNEmpty\<T\>
+▸ **isNumberSafeInt**\<`T`\>(`v`): v is ArrayNonEmpty\<T\>
 
 #### Type parameters
 
@@ -28,4 +28,4 @@
 
 #### Returns
 
-v is ArrayNoNEmpty\<T\>
+v is ArrayNonEmpty\<T\>
diff --git a/packages/assert/docs/api/modules/number_types.md b/packages/assert/docs/api/modules/number_types.md
@@ -12,4 +12,4 @@
 
 ### NumberSafeInt
 
-Ƭ **NumberSafeInt**: `number`
+Ƭ **NumberSafeInt**: `number` & `WeakOpaqueContainer`\<``"NumberSafeInt"``\>
diff --git a/packages/assert/docs/api/modules/object_asserts.md b/packages/assert/docs/api/modules/object_asserts.md
@@ -12,7 +12,7 @@
 
 ### assertPlainObject
 
-▸ **assertPlainObject**(`v`, `msgOrErrorFactory?`): asserts v is string
+▸ **assertPlainObject**(`v`, `msgOrErrorFactory?`): asserts v is PlainObject
 
 Assert a value is a plain object
 
@@ -25,7 +25,7 @@ Assert a value is a plain object
 
 #### Returns
 
-asserts v is string
+asserts v is PlainObject
 
 **`Throws`**
 

diff --git a/packages/assert/docs/api/modules/string_asserts.md b/packages/assert/docs/api/modules/string_asserts.md
@@ -14,7 +14,7 @@
 
 ### assertParsableSafeInt
 
-▸ **assertParsableSafeInt**(`v`, `msgOrErrorFactory?`): asserts v is string
+▸ **assertParsableSafeInt**(`v`, `msgOrErrorFactory?`): asserts v is ParsableSafeInt
 
 #### Parameters
 
@@ -25,13 +25,13 @@
 
 #### Returns
 
-asserts v is string
+asserts v is ParsableSafeInt
 
 ___
 
 ### assertParsableStrictIsoDateZ
 
-▸ **assertParsableStrictIsoDateZ**(`v`, `msgOrErrorFactory?`): asserts v is string
+▸ **assertParsableStrictIsoDateZ**(`v`, `msgOrErrorFactory?`): asserts v is ParsableStrictIsoDateZ
 
 #### Parameters
 
@@ -42,7 +42,7 @@ ___
 
 #### Returns
 
-asserts v is string
+asserts v is ParsableStrictIsoDateZ
 
 **`Throws`**
 

diff --git a/packages/assert/docs/api/modules/string_guards.md b/packages/assert/docs/api/modules/string_guards.md
@@ -14,7 +14,7 @@
 
 ### isParsableSafeInt
 
-▸ **isParsableSafeInt**(`v`): v is string
+▸ **isParsableSafeInt**(`v`): v is ParsableSafeInt
 
 #### Parameters
 
@@ -24,13 +24,13 @@
 
 #### Returns
 
-v is string
+v is ParsableSafeInt
 
 ___
 
 ### isParsableStrictIsoDateZ
 
-▸ **isParsableStrictIsoDateZ**(`v`): v is string
+▸ **isParsableStrictIsoDateZ**(`v`): v is ParsableStrictIsoDateZ
 
 Checks if the value is a string containing a valid ISO-8601 date time
 with microseconds that ends with 'z' representing UTC+0 timezone (aka zulu time).
@@ -48,7 +48,7 @@ isStrParsableIsoDateZ('2023-12-29T23:37:31.653z')
 
 #### Returns
 
-v is string
+v is ParsableStrictIsoDateZ
 
 **`Link`**
 
@@ -66,7 +66,7 @@ ___
 
 ### isStringNonEmpty
 
-▸ **isStringNonEmpty**(`v`): v is string
+▸ **isStringNonEmpty**(`v`): v is StringNonEmpty
 
 #### Parameters
 
@@ -76,4 +76,4 @@ ___
 
 #### Returns
 
-v is string
+v is StringNonEmpty
diff --git a/packages/assert/docs/api/modules/string_types.md b/packages/assert/docs/api/modules/string_types.md
@@ -14,16 +14,16 @@
 
 ### ParsableSafeInt
 
-Ƭ **ParsableSafeInt**: `string`
+Ƭ **ParsableSafeInt**: `string` & `WeakOpaqueContainer`\<``"ParsableSafeInt"``\>
 
 ___
 
 ### ParsableStrictIsoDateZ
 
-Ƭ **ParsableStrictIsoDateZ**: `string`
+Ƭ **ParsableStrictIsoDateZ**: `string` & `WeakOpaqueContainer`\<``"ParsableStrictIsoDateZ"``\>
 
 ___
 
 ### StringNonEmpty
 
-Ƭ **StringNonEmpty**: `string`
+Ƭ **StringNonEmpty**: `string` & `WeakOpaqueContainer`\<``"ParsableStrictIsoDateZ"``\>
diff --git a/packages/assert/docs/api/modules/uuid_asserts.md b/packages/assert/docs/api/modules/uuid_asserts.md
@@ -16,7 +16,7 @@
 
 ### assertUuid
 
-▸ **assertUuid**(`v`, `msgOrErrorFactory?`, `options?`): asserts v is string
+▸ **assertUuid**(`v`, `msgOrErrorFactory?`, `options?`): asserts v is Uuid
 
 Asserts a value is a valid uuid v1, v3, v4 or v5
 Accept optional version
@@ -32,7 +32,7 @@ Accept optional version
 
 #### Returns
 
-asserts v is string
+asserts v is Uuid
 
 **`Throws`**
 
@@ -42,7 +42,7 @@ ___
 
 ### assertUuidV1
 
-▸ **assertUuidV1**(`v`, `msgOrErrorFactory?`): asserts v is string
+▸ **assertUuidV1**(`v`, `msgOrErrorFactory?`): asserts v is UuidV1
 
 Asserts a value is a valid uuid v1
 
@@ -55,7 +55,7 @@ Asserts a value is a valid uuid v1
 
 #### Returns
 
-asserts v is string
+asserts v is UuidV1
 
 **`Throws`**
 
@@ -65,7 +65,7 @@ ___
 
 ### assertUuidV3
 
-▸ **assertUuidV3**(`v`, `msgOrErrorFactory?`): asserts v is string
+▸ **assertUuidV3**(`v`, `msgOrErrorFactory?`): asserts v is UuidV3
 
 Asserts a value is a valid uuid v3
 
@@ -78,7 +78,7 @@ Asserts a value is a valid uuid v3
 
 #### Returns
 
-asserts v is string
+asserts v is UuidV3
 
 **`Throws`**
 
@@ -88,7 +88,7 @@ ___
 
 ### assertUuidV4
 
-▸ **assertUuidV4**(`v`, `msgOrErrorFactory?`): asserts v is string
+▸ **assertUuidV4**(`v`, `msgOrErrorFactory?`): asserts v is UuidV4
 
 Assert a value is a valid uuid v4
 
@@ -101,7 +101,7 @@ Assert a value is a valid uuid v4
 
 #### Returns
 
-asserts v is string
+asserts v is UuidV4
 
 **`Throws`**
 
@@ -111,7 +111,7 @@ ___
 
 ### assertUuidV5
 
-▸ **assertUuidV5**(`v`, `msgOrErrorFactory?`): asserts v is string
+▸ **assertUuidV5**(`v`, `msgOrErrorFactory?`): asserts v is UuidV5
 
 Assert a value is a valid uuid v5
 
@@ -124,7 +124,7 @@ Assert a value is a valid uuid v5
 
 #### Returns
 
-asserts v is string
+asserts v is UuidV5
 
 **`Throws`**
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,4 +12,4 @@

		### Ean13

		Ƭ Ean13: `string`
		Ƭ Ean13: `string` & `WeakOpaqueContainer`\<``"Ean13"``\>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,4 +12,4 @@

		### NumberSafeInt

		Ƭ NumberSafeInt: `number`
		Ƭ NumberSafeInt: `number` & `WeakOpaqueContainer`\<``"NumberSafeInt"``\>