Module: thing/add#

Type Aliases#

AddOfType#

Ƭ AddOfType<Type>: <T>(thing: T, property: Url | UrlString, value: Type) => T

Type parameters#

Name
`Type`

Type declaration#

▸ <T>(thing, property, value): T

Type parameters#

Name	Type
`T`	extends `Thing`

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`Url` \| `UrlString`	Property on which to add the given value.
`value`	`Type`	Value to add to `thing` for the given `property`.

Returns#

T

A new Thing equal to the input Thing with the given value removed for the given Property.

Defined in#

src/thing/add.ts:494

Functions#

addBoolean#

▸ addBoolean<T>(thing, property, value): T

Create a new Thing with a boolean added for a Property.

This preserves existing values for the given Property. To replace them, see [[setBoolean]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a boolean value to.
`property`	`string` \| `Url`	Property for which to add the given boolean value.
`value`	`boolean`	Boolean to add to `thing` for the given `property`.

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Defined in#

src/thing/add.ts:494

addDate#

▸ addDate<T>(thing, property, value): T

Create a new Thing with a date added for a Property.

This preserves existing values for the given Property. To replace them, see [[setDate]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a date value to.
`property`	`string` \| `Url`	Property for which to add the given date value.
`value`	`Date`	Date to add to `thing` for the given `property`.

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Since

1.10.0

Defined in#

src/thing/add.ts:494

addDatetime#

▸ addDatetime<T>(thing, property, value): T

Create a new Thing with a datetime added for a Property.

This preserves existing values for the given Property. To replace them, see [[setDatetime]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a datetime value to.
`property`	`string` \| `Url`	Property for which to add the given datetime value.
`value`	`Date`	Datetime to add to `thing` for the given `property`.

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Defined in#

src/thing/add.ts:494

addDecimal#

▸ addDecimal<T>(thing, property, value): T

Create a new Thing with a decimal added for a Property.

This preserves existing values for the given Property. To replace them, see [[setDecimal]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a decimal value to.
`property`	`string` \| `Url`	Property for which to add the given decimal value.
`value`	`number`	Decimal to add to `thing` for the given `property`.

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Defined in#

src/thing/add.ts:494

addInteger#

▸ addInteger<T>(thing, property, value): T

Create a new Thing with an integer added for a Property.

This preserves existing values for the given Property. To replace them, see [[setInteger]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add an integer value to.
`property`	`string` \| `Url`	Property for which to add the given integer value.
`value`	`number`	Integer to add to `thing` for the given `property`.

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Defined in#

src/thing/add.ts:494

addStringEnglish#

▸ addStringEnglish<T>(thing, property, value): T

Create a new Thing with an English string added for a Property.

This preserves existing values for the given Property. To replace them, see [[setStringEnglish]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a localised string value to.
`property`	`string` \| `Url`	Property for which to add the given string value.
`value`	`string`	String to add to `thing` for the given `property`.

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Since

1.13.0

Defined in#

src/thing/add.ts:257

addStringNoLocale#

▸ addStringNoLocale<T>(thing, property, value): T

Create a new Thing with an unlocalised string added for a Property.

This preserves existing values for the given Property. To replace them, see [[setStringNoLocale]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add an unlocalised string value to.
`property`	`string` \| `Url`	Property for which to add the given string value.
`value`	`string`	String to add to `thing` for the given `property`.

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Defined in#

src/thing/add.ts:494

addStringWithLocale#

▸ addStringWithLocale<T>(thing, property, value, locale): T

Create a new Thing with a localised string added for a Property.

This preserves existing values for the given Property. To replace them, see [[setStringWithLocale]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a localised string value to.
`property`	`string` \| `Url`	Property for which to add the given string value.
`value`	`string`	String to add to `thing` for the given `property`.
`locale`	`string`	Locale of the added string.

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Defined in#

src/thing/add.ts:278

addTime#

▸ addTime<T>(thing, property, value): T

Create a new Thing with a time added for a Property.

This preserves existing values for the given Property. To replace them, see [[setDatetime]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a datetime value to.
`property`	`string` \| `Url`	Property for which to add the given datetime value.
`value`	`Time`	time to add to `thing` for the given `property`.

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Since

1.10.0

Defined in#

src/thing/add.ts:494

addUrl#

▸ addUrl<T>(thing, property, value): T

Create a new Thing with a URL added for a Property.

This preserves existing values for the given Property. To replace them, see [[setUrl]].

The original thing is not modified; this function returns a cloned Thing with updated values.

Type parameters#

Name	Type
`T`	extends `Readonly`<{}>

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a URL value to.
`property`	`string` \| `Url`	Property for which to add the given URL value.
`value`	`string` \| `Url` \| `Readonly`<{}>	-

Returns#

T

A new Thing equal to the input Thing with the given value added for the given Property.

Defined in#

src/thing/add.ts:494