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:495

Functions#

addBoolean#

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

Type parameters#

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

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`string` \| `Url`	Property on which to add the given value.
`value`	`boolean`	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:495

addDate#

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

Type parameters#

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

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`string` \| `Url`	Property on which to add the given value.
`value`	`Date`	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:495

addDatetime#

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

Type parameters#

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

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`string` \| `Url`	Property on which to add the given value.
`value`	`Date`	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:495

addDecimal#

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

Type parameters#

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

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`string` \| `Url`	Property on which to add the given value.
`value`	`number`	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:495

addInteger#

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

Type parameters#

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

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`string` \| `Url`	Property on which to add the given value.
`value`	`number`	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:495

addIri#

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

Type parameters#

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

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`string` \| `Url`	Property on which to add the given value.
`value`	`string` \| `Url` \| `Readonly`<{}>	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:495

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.

Since

1.13.0

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.

Defined in#

src/thing/add.ts:258

addStringNoLocale#

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

Type parameters#

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

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`string` \| `Url`	Property on which to add the given value.
`value`	`string`	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:495

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:279

addTime#

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

Type parameters#

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

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`string` \| `Url`	Property on which to add the given value.
`value`	`Time`	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:495

addUrl#

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

Type parameters#

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

Parameters#

Name	Type	Description
`thing`	`T`	Thing to add a value to.
`property`	`string` \| `Url`	Property on which to add the given value.
`value`	`string` \| `Url` \| `Readonly`<{}>	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:495