@twin.org/core 0.0.1-next.1

package/docs/reference/classes/HexHelper.md

@@ -0,0 +1,97 @@
+# Class: HexHelper
+
+Helper methods for hex conversions.
+
+## Constructors
+
+### new HexHelper()
+
+> **new HexHelper**(): [`HexHelper`](HexHelper.md)
+
+#### Returns
+
+[`HexHelper`](HexHelper.md)
+
+## Methods
+
+### stripPrefix()
+
+> `static` **stripPrefix**(`hex`): `string`
+
+Strip the 0x prefix if it exists.
+
+#### Parameters
+
+• **hex**: `string`
+
+The hex value to strip.
+
+#### Returns
+
+`string`
+
+The stripped hex without the prefix.
+
+***
+
+### addPrefix()
+
+> `static` **addPrefix**(`hex`): `string`
+
+Add the 0x prefix if it does not exist.
+
+#### Parameters
+
+• **hex**: `string`
+
+The hex value to add the prefix to.
+
+#### Returns
+
+`string`
+
+The hex with the prefix.
+
+***
+
+### hasPrefix()
+
+> `static` **hasPrefix**(`hex`): `boolean`
+
+Does the hex string have the prefix.
+
+#### Parameters
+
+• **hex**: `string`
+
+The hex value to check for the prefix.
+
+#### Returns
+
+`boolean`
+
+True if the hex string has the prefix.
+
+***
+
+### isHex()
+
+> `static` **isHex**(`value`, `allowPrefix`): `boolean`
+
+Is the data hex format.
+
+#### Parameters
+
+• **value**: `string`
+
+The value to test.
+
+• **allowPrefix**: `boolean` = `false`
+
+Allow the hex to have the 0x prefix.
+
+#### Returns
+
+`boolean`
+
+True if the string is hex.

package/docs/reference/classes/I18n.md

@@ -0,0 +1,237 @@
+# Class: I18n
+
+Class to perform internationalization.
+
+## Constructors
+
+### new I18n()
+
+> **new I18n**(): [`I18n`](I18n.md)
+
+#### Returns
+
+[`I18n`](I18n.md)
+
+## Properties
+
+### DEFAULT\_LOCALE
+
+> `static` **DEFAULT\_LOCALE**: `string` = `"en"`
+
+The default translation.
+
+## Methods
+
+### setLocale()
+
+> `static` **setLocale**(`locale`): `void`
+
+Set the locale.
+
+#### Parameters
+
+• **locale**: `string`
+
+The new locale.
+
+#### Returns
+
+`void`
+
+***
+
+### getLocale()
+
+> `static` **getLocale**(): `string`
+
+Get the locale.
+
+#### Returns
+
+`string`
+
+The current locale.
+
+***
+
+### addDictionary()
+
+> `static` **addDictionary**(`locale`, `dictionary`): `void`
+
+Add a locale dictionary.
+
+#### Parameters
+
+• **locale**: `string`
+
+The locale.
+
+• **dictionary**: [`ILocaleDictionary`](../interfaces/ILocaleDictionary.md)
+
+The dictionary to add.
+
+#### Returns
+
+`void`
+
+***
+
+### getDictionary()
+
+> `static` **getDictionary**(`locale`): `undefined` \| `object`
+
+Get a locale dictionary.
+
+#### Parameters
+
+• **locale**: `string`
+
+The locale.
+
+#### Returns
+
+`undefined` \| `object`
+
+The dictionary of undefined if it does not exist.
+
+***
+
+### getAllDictionaries()
+
+> `static` **getAllDictionaries**(): `object`
+
+Get all the locale dictionaries.
+
+#### Returns
+
+`object`
+
+The dictionaries.
+
+***
+
+### addLocaleHandler()
+
+> `static` **addLocaleHandler**(`id`, `handler`): `void`
+
+Add a locale changed handler.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the handler.
+
+• **handler**
+
+The handler to add.
+
+#### Returns
+
+`void`
+
+***
+
+### removeLocaleHandler()
+
+> `static` **removeLocaleHandler**(`id`): `void`
+
+Remove a locale changed handler.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the handler.
+
+#### Returns
+
+`void`
+
+***
+
+### addDictionaryHandler()
+
+> `static` **addDictionaryHandler**(`id`, `handler`): `void`
+
+Add a dictionary changed handler.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the handler.
+
+• **handler**
+
+The handler to add.
+
+#### Returns
+
+`void`
+
+***
+
+### removeDictionaryHandler()
+
+> `static` **removeDictionaryHandler**(`id`): `void`
+
+Remove a dictionary changed handler.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the handler.
+
+#### Returns
+
+`void`
+
+***
+
+### formatMessage()
+
+> `static` **formatMessage**(`key`, `values`?, `overrideLocale`?): `string`
+
+Format a message.
+
+#### Parameters
+
+• **key**: `string`
+
+The key of the message to format.
+
+• **values?**
+
+The values to substitute into the message.
+
+• **overrideLocale?**: `string`
+
+Override the locale.
+
+#### Returns
+
+`string`
+
+The formatted string.
+
+***
+
+### hasMessage()
+
+> `static` **hasMessage**(`key`): `boolean`
+
+Check if the dictionaries have a message for the given key.
+
+#### Parameters
+
+• **key**: `string`
+
+The key to check for existence.
+
+#### Returns
+
+`boolean`
+
+True if the key exists.