@twin.org/core 0.0.2-next.9 → 0.0.3-next.2

package/docs/reference/classes/Coerce.md

@@ -16,7 +16,7 @@ Coerce an object from one type to another.
 
 ### string()
 
-> `static` **string**(`value`): `undefined` \| `string`
+> `static` **string**(`value`): `string` \| `undefined`
 
 Coerce the value to a string.
 
@@ -30,7 +30,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The value if it can be coerced.
 
@@ -42,7 +42,7 @@ TypeError If the value can not be coerced.
 
 ### number()
 
-> `static` **number**(`value`): `undefined` \| `number`
+> `static` **number**(`value`): `number` \| `undefined`
 
 Coerce the value to a number.
 
@@ -56,7 +56,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `number`
+`number` \| `undefined`
 
 The value if it can be coerced.
 
@@ -68,7 +68,7 @@ TypeError If the value can not be coerced.
 
 ### integer()
 
-> `static` **integer**(`value`): `undefined` \| `number`
+> `static` **integer**(`value`): `number` \| `undefined`
 
 Coerce the value to an integer.
 
@@ -82,7 +82,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `number`
+`number` \| `undefined`
 
 The value if it can be coerced.
 
@@ -94,7 +94,7 @@ TypeError If the value can not be coerced.
 
 ### bigint()
 
-> `static` **bigint**(`value`): `undefined` \| `bigint`
+> `static` **bigint**(`value`): `bigint` \| `undefined`
 
 Coerce the value to a bigint.
 
@@ -108,7 +108,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `bigint`
+`bigint` \| `undefined`
 
 The value if it can be coerced.
 
@@ -120,7 +120,7 @@ TypeError If the value can not be coerced.
 
 ### boolean()
 
-> `static` **boolean**(`value`): `undefined` \| `boolean`
+> `static` **boolean**(`value`): `boolean` \| `undefined`
 
 Coerce the value to a boolean.
 
@@ -134,7 +134,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `boolean`
+`boolean` \| `undefined`
 
 The value if it can be coerced.
 
@@ -146,7 +146,7 @@ TypeError If the value can not be coerced.
 
 ### date()
 
-> `static` **date**(`value`): `undefined` \| `Date`
+> `static` **date**(`value`): `Date` \| `undefined`
 
 Coerce the value to a date.
 
@@ -160,7 +160,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `Date`
+`Date` \| `undefined`
 
 The value if it can be coerced.
 
@@ -172,7 +172,7 @@ TypeError If the value can not be coerced.
 
 ### dateTime()
 
-> `static` **dateTime**(`value`): `undefined` \| `Date`
+> `static` **dateTime**(`value`): `Date` \| `undefined`
 
 Coerce the value to a date/time.
 
@@ -186,7 +186,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `Date`
+`Date` \| `undefined`
 
 The value if it can be coerced.
 
@@ -198,7 +198,7 @@ TypeError If the value can not be coerced.
 
 ### time()
 
-> `static` **time**(`value`): `undefined` \| `Date`
+> `static` **time**(`value`): `Date` \| `undefined`
 
 Coerce the value to a time.
 
@@ -212,7 +212,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `Date`
+`Date` \| `undefined`
 
 The value if it can be coerced.
 
@@ -224,7 +224,7 @@ TypeError If the value can not be coerced.
 
 ### object()
 
-> `static` **object**\<`T`\>(`value`): `undefined` \| `T`
+> `static` **object**\<`T`\>(`value`): `T` \| `undefined`
 
 Coerce the value to an object.
 
@@ -244,7 +244,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The value if it can be coerced.
 
@@ -256,7 +256,7 @@ TypeError If the value can not be coerced.
 
 ### uint8Array()
 
-> `static` **uint8Array**(`value`): `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>
+> `static` **uint8Array**(`value`): `Uint8Array`\<`ArrayBufferLike`\> \| `undefined`
 
 Coerce the value to a Uint8Array.
 
@@ -270,7 +270,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>
+`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`
 
 The value if it can be coerced.
 

package/docs/reference/classes/Compression.md

@@ -12,6 +12,14 @@ A class to handle compression.
 
 `Compression`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### compress()

package/docs/reference/classes/ConflictError.md

@@ -10,7 +10,7 @@ Class to handle errors which are triggered by conflicting data.
 
 ### Constructor
 
-> **new ConflictError**(`source`, `message`, `conflictId?`, `conflicts?`, `cause?`): `ConflictError`
+> **new ConflictError**(`source`, `message`, `conflictId?`, `conflicts?`, `properties?`, `cause?`): `ConflictError`
 
 Create a new instance of ConflictError.
 
@@ -40,6 +40,10 @@ The id that has conflicts.
 
 The conflicts that occurred.
 
+##### properties?
+
+Any additional information for the error.
+
 ##### cause?
 
 `unknown`
@@ -158,7 +162,7 @@ The list of all internal errors.
 
 ### expand()
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -168,11 +172,11 @@ Expand an error tree.
 
 The list of errors to expand.
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+[`IError`](../interfaces/IError.md)[] | `undefined`
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 

package/docs/reference/classes/ErrorHelper.md

@@ -66,7 +66,7 @@ The localized version of the errors flattened.
 
 ### formatValidationErrors()
 
-> `static` **formatValidationErrors**(`error`): `undefined` \| `string`
+> `static` **formatValidationErrors**(`error`): `string` \| `undefined`
 
 Localize the content of an error and any causes.
 
@@ -80,6 +80,6 @@ The error to format.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The localized version of the errors flattened.

package/docs/reference/classes/Factory.md

@@ -8,6 +8,14 @@ Factory for creating implementation of generic types.
 
 `T`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### createFactory()
@@ -38,7 +46,7 @@ Automatically create an instance when registered.
 
 ##### matcher?
 
-(`names`, `name`) => `undefined` \| `string`
+(`names`, `name`) => `string` \| `undefined`
 
 Match the name of the instance.
 
@@ -186,7 +194,7 @@ GeneralError if no item exists to get.
 
 ### getIfExists()
 
-> **getIfExists**\<`U`\>(`name?`): `undefined` \| `U`
+> **getIfExists**\<`U`\>(`name?`): `U` \| `undefined`
 
 Get a generator instance with no exceptions.
 
@@ -206,7 +214,7 @@ The name of the instance to generate.
 
 #### Returns
 
-`undefined` \| `U`
+`U` \| `undefined`
 
 An instance of the item or undefined if it does not exist.
 

package/docs/reference/classes/GeneralError.md

@@ -150,7 +150,7 @@ The list of all internal errors.
 
 ### expand()
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -160,11 +160,11 @@ Expand an error tree.
 
 The list of errors to expand.
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+[`IError`](../interfaces/IError.md)[] | `undefined`
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 

package/docs/reference/classes/GuardError.md

@@ -158,7 +158,7 @@ The list of all internal errors.
 
 ### expand()
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -168,11 +168,11 @@ Expand an error tree.
 
 The list of errors to expand.
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+[`IError`](../interfaces/IError.md)[] | `undefined`
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 

package/docs/reference/classes/Guards.md

@@ -958,10 +958,16 @@ GuardError If the value does not match the assertion.
 
 ### function()
 
-> `static` **function**(`source`, `property`, `value`): `boolean`
+> `static` **function**\<`T`\>(`source`, `property`, `value`): `asserts value is T`
 
 Is the property a function.
 
+#### Type Parameters
+
+##### T
+
+`T` *extends* (...`args`) => `any` = (...`args`) => `any`
+
 #### Parameters
 
 ##### source
@@ -984,9 +990,7 @@ The value to test.
 
 #### Returns
 
-`boolean`
-
-True if the value is a function.
+`asserts value is T`
 
 #### Throws
 

package/docs/reference/classes/I18n.md

@@ -84,7 +84,7 @@ The dictionary to add.
 
 ### getDictionary()
 
-> `static` **getDictionary**(`locale`): `undefined` \| \{\[`key`: `string`\]: `string`; \}
+> `static` **getDictionary**(`locale`): \{\[`key`: `string`\]: `string`; \} \| `undefined`
 
 Get a locale dictionary.
 
@@ -98,7 +98,7 @@ The locale.
 
 #### Returns
 
-`undefined` \| \{\[`key`: `string`\]: `string`; \}
+\{\[`key`: `string`\]: `string`; \} \| `undefined`
 
 The dictionary of undefined if it does not exist.
 
@@ -261,3 +261,55 @@ The key to check for existence.
 `boolean`
 
 True if the key exists.
+
+***
+
+### flattenTranslationKeys()
+
+> `static` **flattenTranslationKeys**(`translation`, `propertyPath`, `mergedKeys`): `void`
+
+Flatten the translation property paths for faster lookup.
+
+#### Parameters
+
+##### translation
+
+[`ILocaleDictionary`](../interfaces/ILocaleDictionary.md)
+
+The translation to merge.
+
+##### propertyPath
+
+`string`
+
+The current root path.
+
+##### mergedKeys
+
+The merged keys dictionary to populate.
+
+#### Returns
+
+`void`
+
+***
+
+### getPropertyNames()
+
+> `static` **getPropertyNames**(`message`): `string`[]
+
+Get a list of the property names from the message.
+
+#### Parameters
+
+##### message
+
+`string`
+
+The message to extract the property names from.
+
+#### Returns
+
+`string`[]
+
+The list of property names.

package/docs/reference/classes/Is.md

@@ -60,7 +60,7 @@ True if the value is a empty.
 
 ### empty()
 
-> `static` **empty**(`value`): value is undefined \| null
+> `static` **empty**(`value`): value is null \| undefined
 
 Is the property null or undefined.
 
@@ -74,7 +74,7 @@ The value to test.
 
 #### Returns
 
-value is undefined \| null
+value is null \| undefined
 
 True if the value is a empty.
 
@@ -730,10 +730,16 @@ True if the value is a TypedArray.
 
 ### function()
 
-> `static` **function**(`value`): `value is (args: unknown[]) => unknown`
+> `static` **function**\<`T`\>(`value`): `value is T`
 
 Is the property a function.
 
+#### Type Parameters
+
+##### T
+
+`T` *extends* (...`args`) => `any` = (...`args`) => `any`
+
 #### Parameters
 
 ##### value
@@ -744,7 +750,7 @@ The value to test.
 
 #### Returns
 
-`value is (args: unknown[]) => unknown`
+`value is T`
 
 True if the value is a function.
 

package/docs/reference/classes/JsonHelper.md

@@ -12,6 +12,14 @@ Helpers methods for JSON objects.
 
 `JsonHelper`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### canonicalize()

package/docs/reference/classes/NotFoundError.md

@@ -10,7 +10,7 @@ Class to handle errors which are triggered by data not being found.
 
 ### Constructor
 
-> **new NotFoundError**(`source`, `message`, `notFoundId?`, `cause?`): `NotFoundError`
+> **new NotFoundError**(`source`, `message`, `notFoundId?`, `properties?`, `cause?`): `NotFoundError`
 
 Create a new instance of NotFoundError.
 
@@ -34,6 +34,10 @@ The message as a code.
 
 The id for the item.
 
+##### properties?
+
+Any additional information for the error.
+
 ##### cause?
 
 `unknown`
@@ -152,7 +156,7 @@ The list of all internal errors.
 
 ### expand()
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -162,11 +166,11 @@ Expand an error tree.
 
 The list of errors to expand.
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+[`IError`](../interfaces/IError.md)[] | `undefined`
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 

package/docs/reference/classes/NotImplementedError.md

@@ -10,7 +10,7 @@ Class to handle errors.
 
 ### Constructor
 
-> **new NotImplementedError**(`source`, `method`): `NotImplementedError`
+> **new NotImplementedError**(`source`, `method`, `properties?`, `cause?`): `NotImplementedError`
 
 Create a new instance of NotImplementedError.
 
@@ -28,6 +28,16 @@ The source of the error.
 
 The method for the error.
 
+##### properties?
+
+Any additional information for the error.
+
+##### cause?
+
+`unknown`
+
+The cause of the error if we have wrapped another error.
+
 #### Returns
 
 `NotImplementedError`
@@ -140,7 +150,7 @@ The list of all internal errors.
 
 ### expand()
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -150,11 +160,11 @@ Expand an error tree.
 
 The list of errors to expand.
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+[`IError`](../interfaces/IError.md)[] | `undefined`
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 

package/docs/reference/classes/NotSupportedError.md

@@ -10,7 +10,7 @@ Class to handle errors when a feature is unsupported.
 
 ### Constructor
 
-> **new NotSupportedError**(`source`, `message`, `cause?`): `NotSupportedError`
+> **new NotSupportedError**(`source`, `message`, `properties?`, `cause?`): `NotSupportedError`
 
 Create a new instance of NotSupportedError.
 
@@ -28,6 +28,10 @@ The source of the error.
 
 The message as a code.
 
+##### properties?
+
+Any additional information for the error.
+
 ##### cause?
 
 `unknown`
@@ -146,7 +150,7 @@ The list of all internal errors.
 
 ### expand()
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -156,11 +160,11 @@ Expand an error tree.
 
 The list of errors to expand.
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+[`IError`](../interfaces/IError.md)[] | `undefined`
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 

package/docs/reference/classes/NumberHelper.md

@@ -0,0 +1,55 @@
+# Class: NumberHelper
+
+Class to help with numbers.
+
+## Constructors
+
+### Constructor
+
+> **new NumberHelper**(): `NumberHelper`
+
+#### Returns
+
+`NumberHelper`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### clamp()
+
+> `static` **clamp**(`value`, `minValue?`, `maxValue?`): `number`
+
+Clamps a number between a minimum and maximum value.
+
+#### Parameters
+
+##### value
+
+`number`
+
+The value to clamp.
+
+##### minValue?
+
+`number`
+
+The minimum value.
+
+##### maxValue?
+
+`number`
+
+The maximum value.
+
+#### Returns
+
+`number`
+
+The clamped value.