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

package/docs/reference/classes/I18n.md

@@ -14,7 +14,7 @@ Class to perform internationalization.
 
 ## Properties
 
-### DEFAULT\_LOCALE
+### DEFAULT\_LOCALE {#default_locale}
 
 > `static` **DEFAULT\_LOCALE**: `string` = `"en"`
 
@@ -22,7 +22,7 @@ The default translation.
 
 ## Methods
 
-### setLocale()
+### setLocale() {#setlocale}
 
 > `static` **setLocale**(`locale`): `void`
 
@@ -42,7 +42,7 @@ The new locale.
 
 ***
 
-### getLocale()
+### getLocale() {#getlocale}
 
 > `static` **getLocale**(): `string`
 
@@ -56,7 +56,7 @@ The current locale.
 
 ***
 
-### addDictionary()
+### addDictionary() {#adddictionary}
 
 > `static` **addDictionary**(`locale`, `dictionary`): `void`
 
@@ -82,9 +82,9 @@ The dictionary to add.
 
 ***
 
-### getDictionary()
+### getDictionary() {#getdictionary}
 
-> `static` **getDictionary**(`locale`): `undefined` \| \{\[`key`: `string`\]: `string`; \}
+> `static` **getDictionary**(`locale`): \{\[`key`: `string`\]: `string`; \} \| `undefined`
 
 Get a locale dictionary.
 
@@ -98,13 +98,13 @@ The locale.
 
 #### Returns
 
-`undefined` \| \{\[`key`: `string`\]: `string`; \}
+\{\[`key`: `string`\]: `string`; \} \| `undefined`
 
 The dictionary of undefined if it does not exist.
 
 ***
 
-### getAllDictionaries()
+### getAllDictionaries() {#getalldictionaries}
 
 > `static` **getAllDictionaries**(): `object`
 
@@ -118,7 +118,7 @@ The dictionaries.
 
 ***
 
-### addLocaleHandler()
+### addLocaleHandler() {#addlocalehandler}
 
 > `static` **addLocaleHandler**(`id`, `handler`): `void`
 
@@ -144,7 +144,7 @@ The handler to add.
 
 ***
 
-### removeLocaleHandler()
+### removeLocaleHandler() {#removelocalehandler}
 
 > `static` **removeLocaleHandler**(`id`): `void`
 
@@ -164,7 +164,7 @@ The id of the handler.
 
 ***
 
-### addDictionaryHandler()
+### addDictionaryHandler() {#adddictionaryhandler}
 
 > `static` **addDictionaryHandler**(`id`, `handler`): `void`
 
@@ -190,7 +190,7 @@ The handler to add.
 
 ***
 
-### removeDictionaryHandler()
+### removeDictionaryHandler() {#removedictionaryhandler}
 
 > `static` **removeDictionaryHandler**(`id`): `void`
 
@@ -210,7 +210,7 @@ The id of the handler.
 
 ***
 
-### formatMessage()
+### formatMessage() {#formatmessage}
 
 > `static` **formatMessage**(`key`, `values?`, `overrideLocale?`): `string`
 
@@ -242,7 +242,7 @@ The formatted string.
 
 ***
 
-### hasMessage()
+### hasMessage() {#hasmessage}
 
 > `static` **hasMessage**(`key`): `boolean`
 
@@ -261,3 +261,55 @@ The key to check for existence.
 `boolean`
 
 True if the key exists.
+
+***
+
+### flattenTranslationKeys() {#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() {#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

@@ -14,7 +14,7 @@ Class to check types of objects.
 
 ## Methods
 
-### undefined()
+### undefined() {#undefined}
 
 > `static` **undefined**(`value`): `value is undefined`
 
@@ -36,7 +36,7 @@ True if the value is a empty.
 
 ***
 
-### null()
+### null() {#null}
 
 > `static` **null**(`value`): `value is null`
 
@@ -58,9 +58,9 @@ True if the value is a empty.
 
 ***
 
-### empty()
+### empty() {#empty}
 
-> `static` **empty**(`value`): value is undefined \| null
+> `static` **empty**(`value`): value is null \| undefined
 
 Is the property null or undefined.
 
@@ -74,13 +74,13 @@ The value to test.
 
 #### Returns
 
-value is undefined \| null
+value is null \| undefined
 
 True if the value is a empty.
 
 ***
 
-### notEmpty()
+### notEmpty() {#notempty}
 
 > `static` **notEmpty**(`value`): `boolean`
 
@@ -102,7 +102,7 @@ True if the value is a not empty.
 
 ***
 
-### string()
+### string() {#string}
 
 > `static` **string**(`value`): `value is string`
 
@@ -124,7 +124,7 @@ True if the value is a string.
 
 ***
 
-### stringValue()
+### stringValue() {#stringvalue}
 
 > `static` **stringValue**(`value`): `value is string`
 
@@ -146,7 +146,7 @@ True if the value is a string.
 
 ***
 
-### json()
+### json() {#json}
 
 > `static` **json**(`value`): `value is string`
 
@@ -168,7 +168,7 @@ True if the value is a JSON string.
 
 ***
 
-### stringBase64()
+### stringBase64() {#stringbase64}
 
 > `static` **stringBase64**(`value`): `value is string`
 
@@ -190,7 +190,7 @@ True if the value is a base64 string.
 
 ***
 
-### stringBase64Url()
+### stringBase64Url() {#stringbase64url}
 
 > `static` **stringBase64Url**(`value`): `value is string`
 
@@ -212,7 +212,7 @@ True if the value is a base64 string.
 
 ***
 
-### stringBase58()
+### stringBase58() {#stringbase58}
 
 > `static` **stringBase58**(`value`): `value is string`
 
@@ -234,9 +234,9 @@ True if the value is a base58 string.
 
 ***
 
-### stringHex()
+### stringHex() {#stringhex}
 
-> `static` **stringHex**(`value`, `allowPrefix`): `value is string`
+> `static` **stringHex**(`value`, `allowPrefix?`): `value is string`
 
 Is the value a hex string.
 
@@ -248,7 +248,7 @@ Is the value a hex string.
 
 The value to test.
 
-##### allowPrefix
+##### allowPrefix?
 
 `boolean` = `false`
 
@@ -262,9 +262,9 @@ True if the value is a hex string.
 
 ***
 
-### stringHexLength()
+### stringHexLength() {#stringhexlength}
 
-> `static` **stringHexLength**(`value`, `length`, `allowPrefix`): `value is string`
+> `static` **stringHexLength**(`value`, `length`, `allowPrefix?`): `value is string`
 
 Is the value a hex string of fixed length.
 
@@ -282,7 +282,7 @@ The value to test.
 
 The length to test.
 
-##### allowPrefix
+##### allowPrefix?
 
 `boolean` = `false`
 
@@ -296,7 +296,7 @@ True if the value is a hex string of required length.
 
 ***
 
-### number()
+### number() {#number}
 
 > `static` **number**(`value`): `value is number`
 
@@ -318,7 +318,7 @@ True if the value is a number.
 
 ***
 
-### integer()
+### integer() {#integer}
 
 > `static` **integer**(`value`): `value is number`
 
@@ -340,7 +340,7 @@ True if the value is an integer.
 
 ***
 
-### bigint()
+### bigint() {#bigint}
 
 > `static` **bigint**(`value`): `value is bigint`
 
@@ -362,7 +362,7 @@ True if the value is a big integer.
 
 ***
 
-### boolean()
+### boolean() {#boolean}
 
 > `static` **boolean**(`value`): `value is boolean`
 
@@ -384,7 +384,7 @@ True if the value is a boolean.
 
 ***
 
-### date()
+### date() {#date}
 
 > `static` **date**(`value`): `value is Date`
 
@@ -406,7 +406,7 @@ True if the value is a date.
 
 ***
 
-### dateEmpty()
+### dateEmpty() {#dateempty}
 
 > `static` **dateEmpty**(`value`): `boolean`
 
@@ -428,7 +428,7 @@ True if the value is an empty date.
 
 ***
 
-### dateString()
+### dateString() {#datestring}
 
 > `static` **dateString**(`value`): `boolean`
 
@@ -450,7 +450,7 @@ True if the value is a string in ISO 8601 date format.
 
 ***
 
-### dateTimeString()
+### dateTimeString() {#datetimestring}
 
 > `static` **dateTimeString**(`value`): `boolean`
 
@@ -472,7 +472,7 @@ True if the value is a string in ISO 8601 date/time format.
 
 ***
 
-### timeString()
+### timeString() {#timestring}
 
 > `static` **timeString**(`value`): `boolean`
 
@@ -494,7 +494,7 @@ True if the value is a string in ISO 8601 time format.
 
 ***
 
-### timestampSeconds()
+### timestampSeconds() {#timestampseconds}
 
 > `static` **timestampSeconds**(`value`): `value is number`
 
@@ -516,7 +516,7 @@ True if the value is a date.
 
 ***
 
-### timestampMilliseconds()
+### timestampMilliseconds() {#timestampmilliseconds}
 
 > `static` **timestampMilliseconds**(`value`): `value is number`
 
@@ -538,7 +538,7 @@ True if the value is a date.
 
 ***
 
-### object()
+### object() {#object}
 
 > `static` **object**\<`T`\>(`value`): `value is T`
 
@@ -566,7 +566,7 @@ True if the value is a object.
 
 ***
 
-### objectValue()
+### objectValue() {#objectvalue}
 
 > `static` **objectValue**\<`T`\>(`value`): `value is T`
 
@@ -594,7 +594,7 @@ True if the value is a object.
 
 ***
 
-### array()
+### array() {#array}
 
 > `static` **array**\<`T`\>(`value`): `value is T[]`
 
@@ -622,7 +622,7 @@ True if the value is an array.
 
 ***
 
-### arrayValue()
+### arrayValue() {#arrayvalue}
 
 > `static` **arrayValue**\<`T`\>(`value`): `value is T[]`
 
@@ -650,7 +650,7 @@ True if the value is an array with at least one element.
 
 ***
 
-### arrayOneOf()
+### arrayOneOf() {#arrayoneof}
 
 > `static` **arrayOneOf**\<`T`\>(`value`, `options`): `value is T`
 
@@ -684,7 +684,7 @@ True if the value is an element from the options array.
 
 ***
 
-### uint8Array()
+### uint8Array() {#uint8array}
 
 > `static` **uint8Array**(`value`): `value is Uint8Array<ArrayBufferLike>`
 
@@ -706,7 +706,7 @@ True if the value is a Uint8Array.
 
 ***
 
-### typedArray()
+### typedArray() {#typedarray}
 
 > `static` **typedArray**(`value`): value is Uint8Array\<ArrayBufferLike\> \| Int8Array\<ArrayBufferLike\> \| Uint16Array\<ArrayBufferLike\> \| Int16Array\<ArrayBufferLike\> \| Uint32Array\<ArrayBufferLike\> \| Int32Array\<ArrayBufferLike\> \| Float32Array\<ArrayBufferLike\> \| Float64Array\<ArrayBufferLike\>
 
@@ -728,12 +728,18 @@ True if the value is a TypedArray.
 
 ***
 
-### function()
+### function() {#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,13 +750,13 @@ The value to test.
 
 #### Returns
 
-`value is (args: unknown[]) => unknown`
+`value is T`
 
 True if the value is a function.
 
 ***
 
-### email()
+### email() {#email}
 
 > `static` **email**(`value`): `value is string`
 
@@ -772,7 +778,7 @@ True if the value is a string.
 
 ***
 
-### promise()
+### promise() {#promise}
 
 > `static` **promise**\<`T`\>(`value`): `value is Promise<T>`
 
@@ -800,7 +806,7 @@ True if the value is a promise.
 
 ***
 
-### regexp()
+### regexp() {#regexp}
 
 > `static` **regexp**(`value`): `value is RegExp`
 
@@ -822,7 +828,7 @@ True if the value is a regexp.
 
 ***
 
-### class()
+### class() {#class}
 
 > `static` **class**\<`T`\>(`obj`): `obj is (args: any[]) => T`
 
@@ -847,3 +853,31 @@ The object to check.
 `obj is (args: any[]) => T`
 
 True if the object is a class, false otherwise.
+
+***
+
+### uuidV7() {#uuidv7}
+
+> `static` **uuidV7**(`value`, `format?`): `value is string`
+
+Is the value a uuidV7 string.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to test.
+
+##### format?
+
+`"standard"` \| `"compact"`
+
+The format of the UUIDv7 string.
+
+#### Returns
+
+`value is string`
+
+True if the value is a uuidV7 string.

package/docs/reference/classes/JsonHelper.md

@@ -12,9 +12,17 @@ Helpers methods for JSON objects.
 
 `JsonHelper`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### canonicalize()
+### canonicalize() {#canonicalize}
 
 > `static` **canonicalize**(`object`): `string`
 
@@ -37,7 +45,7 @@ The serialized object.
 
 ***
 
-### diff()
+### diff() {#diff}
 
 > `static` **diff**\<`T`\>(`object1`, `object2`): [`IPatchOperation`](../interfaces/IPatchOperation.md)[]
 
@@ -72,7 +80,7 @@ The list of patches.
 
 ***
 
-### patch()
+### patch() {#patch}
 
 > `static` **patch**\<`T`\>(`object`, `patches`): `T`
 
@@ -111,7 +119,7 @@ GeneralError if the patch fails.
 
 ***
 
-### stringifyEx()
+### stringifyEx() {#stringifyex}
 
 > `static` **stringifyEx**(`object`, `space?`): `string`
 
@@ -127,9 +135,9 @@ The object to stringify.
 
 ##### space?
 
-Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+`string` \| `number`
 
-`string` | `number`
+Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
 
 #### Returns
 
@@ -139,7 +147,7 @@ The stringified object.
 
 ***
 
-### parseEx()
+### parseEx() {#parseex}
 
 > `static` **parseEx**(`json`): `any`
 
@@ -161,7 +169,7 @@ The object.
 
 ***
 
-### stringifyExReplacer()
+### stringifyExReplacer() {#stringifyexreplacer}
 
 > `static` **stringifyExReplacer**(`this`, `key`, `value`): `unknown`
 
@@ -195,7 +203,7 @@ The value.
 
 ***
 
-### parseExReviver()
+### parseExReviver() {#parseexreviver}
 
 > `static` **parseExReviver**(`this`, `key`, `value`): `unknown`