@twin.org/core 0.0.4-next.9 → 0.9.0-next.1

package/docs/reference/classes/Duration.md

@@ -0,0 +1,88 @@
+# Class: Duration
+
+Helper methods for working with ISO 8601 durations.
+
+## Constructors
+
+### Constructor
+
+> **new Duration**(): `Duration`
+
+#### Returns
+
+`Duration`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### parse() {#parse}
+
+> `static` **parse**(`value`): [`IDuration`](../interfaces/IDuration.md) \| `undefined`
+
+Parse an ISO 8601 duration string into its component parts.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The string to parse.
+
+#### Returns
+
+[`IDuration`](../interfaces/IDuration.md) \| `undefined`
+
+The parsed duration, or undefined if the string is not a valid ISO 8601 duration.
+
+***
+
+### toString() {#tostring}
+
+> `static` **toString**(`duration`): `string`
+
+Convert a duration object to an ISO 8601 duration string.
+
+#### Parameters
+
+##### duration
+
+[`IDuration`](../interfaces/IDuration.md)
+
+The duration to convert.
+
+#### Returns
+
+`string`
+
+The ISO 8601 duration string (e.g. "P1Y2M3DT4H5M6S").
+
+***
+
+### toSeconds() {#toseconds}
+
+> `static` **toSeconds**(`duration`): `number`
+
+Convert a duration object to total seconds.
+Year and month components use the average values 365.25 days and 30.4375 days.
+
+#### Parameters
+
+##### duration
+
+[`IDuration`](../interfaces/IDuration.md)
+
+The duration to convert.
+
+#### Returns
+
+`number`
+
+The total number of seconds.

package/docs/reference/classes/Guards.md

@@ -1181,3 +1181,39 @@ The format of the uuidV7, either standard or compact.
 #### Throws
 
 GuardError If the value does not match the assertion.
+
+***
+
+### duration() {#duration}
+
+> `static` **duration**(`source`, `property`, `value`): asserts value is string \| IDuration
+
+Is the property a valid ISO 8601 duration string or IDuration object.
+
+#### Parameters
+
+##### source
+
+`string`
+
+The source of the error.
+
+##### property
+
+`string`
+
+The name of the property.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+#### Returns
+
+asserts value is string \| IDuration
+
+#### Throws
+
+GuardError If the value does not match the assertion.

package/docs/reference/classes/Is.md

@@ -881,3 +881,25 @@ The format of the UUIDv7 string.
 `value is string`
 
 True if the value is a uuidV7 string.
+
+***
+
+### duration() {#duration}
+
+> `static` **duration**(`value`): value is string \| IDuration
+
+Is the value a valid ISO 8601 duration string or an IDuration object.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to test.
+
+#### Returns
+
+value is string \| IDuration
+
+True if the value is a valid ISO 8601 duration string or an IDuration object.

package/docs/reference/classes/Mutex.md

@@ -35,6 +35,44 @@ Runtime name for the class.
 
 ## Methods
 
+### getDefaultTimeoutMs() {#getdefaulttimeoutms}
+
+> `static` **getDefaultTimeoutMs**(): `number`
+
+Gets the default timeout in milliseconds for lock acquisition.
+
+#### Returns
+
+`number`
+
+The default timeout in milliseconds.
+
+***
+
+### setDefaultTimeoutMs() {#setdefaulttimeoutms}
+
+> `static` **setDefaultTimeoutMs**(`timeoutMs`): `void`
+
+Sets the default timeout in milliseconds for lock acquisition.
+
+#### Parameters
+
+##### timeoutMs
+
+`number`
+
+The default timeout in milliseconds.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+GeneralError if timeoutMs is not a non-negative integer.
+
+***
+
 ### lock() {#lock}
 
 > `static` **lock**(`key`, `options?`): `Promise`\<`boolean`\>
@@ -62,7 +100,7 @@ Lock options.
 
 `number`
 
-The maximum time to wait for the lock in milliseconds, default is 5000.
+The maximum time to wait for the lock in milliseconds, defaults to getDefaultTimeoutMs().
 
 ###### throwOnTimeout?
 

package/docs/reference/classes/ObjectHelper.md

@@ -336,10 +336,14 @@ Pick a subset of properties from an object.
 
 #### Param
 
+**obj**
+
 The object to pick the properties from.
 
 #### Param
 
+**keys**
+
 The property keys to pick.
 
 #### Call Signature
@@ -422,10 +426,14 @@ Omit a subset of properties from an object.
 
 #### Param
 
+**obj**
+
 The object to omit the properties from.
 
 #### Param
 
+**keys**
+
 The property keys to omit.
 
 #### Call Signature

package/docs/reference/classes/Url.md

@@ -22,6 +22,10 @@ The url string.
 
 `Url`
 
+#### Throws
+
+GuardError if the url is not valid.
+
 ## Properties
 
 ### CLASS\_NAME {#class_name}

package/docs/reference/index.md

@@ -30,6 +30,7 @@
 - [StringHelper](classes/StringHelper.md)
 - [Uint8ArrayHelper](classes/Uint8ArrayHelper.md)
 - [BitString](classes/BitString.md)
+- [Duration](classes/Duration.md)
 - [Url](classes/Url.md)
 - [Urn](classes/Urn.md)
 - [AsyncCache](classes/AsyncCache.md)
@@ -47,6 +48,7 @@
 ## Interfaces
 
 - [IComponent](interfaces/IComponent.md)
+- [IDuration](interfaces/IDuration.md)
 - [IError](interfaces/IError.md)
 - [IHealth](interfaces/IHealth.md)
 - [II18nShared](interfaces/II18nShared.md)
@@ -81,3 +83,4 @@
 - [HealthStatus](variables/HealthStatus.md)
 - [MutexMessageTypes](variables/MutexMessageTypes.md)
 - [SharedObjectBufferMessageTypes](variables/SharedObjectBufferMessageTypes.md)
+- [DURATION\_REG\_EXP](variables/DURATION_REG_EXP.md)

package/docs/reference/interfaces/IDuration.md

@@ -0,0 +1,83 @@
+# Interface: IDuration
+
+Represents a duration broken down into its component parts.
+
+## Properties
+
+### years {#years}
+
+> **years**: `number`
+
+The number of years.
+
+***
+
+### months {#months}
+
+> **months**: `number`
+
+The number of months.
+
+***
+
+### weeks {#weeks}
+
+> **weeks**: `number`
+
+The number of weeks.
+
+***
+
+### days {#days}
+
+> **days**: `number`
+
+The number of days.
+
+***
+
+### hours {#hours}
+
+> **hours**: `number`
+
+The number of hours.
+
+***
+
+### minutes {#minutes}
+
+> **minutes**: `number`
+
+The number of minutes.
+
+***
+
+### seconds {#seconds}
+
+> **seconds**: `number`
+
+The number of seconds.
+
+***
+
+### milliseconds? {#milliseconds}
+
+> `optional` **milliseconds?**: `number`
+
+The number of milliseconds.
+
+***
+
+### microseconds? {#microseconds}
+
+> `optional` **microseconds?**: `number`
+
+The number of microseconds.
+
+***
+
+### nanoseconds? {#nanoseconds}
+
+> `optional` **nanoseconds?**: `number`
+
+The number of nanoseconds.

package/docs/reference/variables/CoerceType.md

@@ -65,3 +65,9 @@ Object.
 > `readonly` **Uint8Array**: `"uint8array"` = `"uint8array"`
 
 Uint8Array.
+
+### Duration {#duration}
+
+> `readonly` **Duration**: `"duration"` = `"duration"`
+
+Duration in seconds.

package/docs/reference/variables/DURATION_REG_EXP.md

@@ -0,0 +1,3 @@
+# Variable: DURATION\_REG\_EXP
+
+> `const` **DURATION\_REG\_EXP**: `RegExp`

package/locales/en.json

@@ -74,7 +74,8 @@
 			"url": "Property \"{property}\" must be a URL formatted string, it is \"{value}\"",
 			"email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\"",
 			"uuidV7": "Property \"{property}\" must be a UUIDv7 formatted string, it is \"{value}\"",
-			"uuidV7Compact": "Property \"{property}\" must be a UUIDv7 formatted string in compact mode, it is \"{value}\""
+			"uuidV7Compact": "Property \"{property}\" must be a UUIDv7 formatted string in compact mode, it is \"{value}\"",
+			"duration": "Property \"{property}\" must be an ISO 8601 duration string, it is \"{value}\""
 		},
 		"objectHelper": {
 			"failedBytesToJSON": "Failed converting bytes to JSON",
@@ -109,7 +110,8 @@
 			"lockNotFound": "The key \"{key}\" has no active lock",
 			"lockAlreadyReleased": "The key \"{key}\" is not currently locked",
 			"lockTimeout": "Failed to acquire lock for key \"{key}\" within the timeout of {timeout} milliseconds",
-			"bufferFetchFailed": "Failed to retrieve shared buffer for key \"{key}\" from the main thread"
+			"bufferFetchFailed": "Failed to retrieve shared buffer for key \"{key}\" from the main thread",
+			"invalidTimeout": "The timeout value \"{timeoutMs}\" is invalid, it must be a non-negative integer"
 		},
 		"sharedObjectBuffer": {
 			"notCreated": "The shared buffer for object \"{objectId}\" has not been created",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.4-next.9",
+	"version": "0.9.0-next.1",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "0.0.4-next.9",
-		"intl-messageformat": "11.2.6",
+		"@twin.org/nameof": "0.9.0-next.1",
+		"intl-messageformat": "11.2.8",
 		"rfc6902": "5.2.0"
 	},
 	"main": "./dist/es/index.js",