Module: thing/remove#

Type Aliases#

RemoveOfType#

Ƭ RemoveOfType<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 remove a value from.
`property`	`Url` \| `UrlString`	Property for which to remove the given value.
`value`	`Type`	Value to remove from `thing` for the given `property`.

Returns#

T

Defined in#

src/thing/remove.ts:500

Functions#

removeAll#

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

Create a new Thing with all values removed for the given Property.

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 remove values from.
`property`	`string` \| `Url`	Property for which to remove all values from the Thing.

Returns#

T

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

Defined in#

src/thing/remove.ts:55

removeBoolean#

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

Create a new Thing with the given boolean removed for the given Property.

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 remove a boolean value from.
`property`	`string` \| `Url`	Property for which to remove the given boolean value.
`value`	`boolean`	Boolean to remove from `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/remove.ts:137

removeDate#

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

Create a new Thing with the given date removed for the given Property.

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 remove a date value from.
`property`	`string` \| `Url`	Property for which to remove the given date value.
`value`	`Date`	Date to remove from `thing` for the given `property`.

Returns#

T

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

Since

1.10.0

Defined in#

src/thing/remove.ts:183

removeDatetime#

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

Create a new Thing with the given datetime removed for the given Property.

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 remove a datetime value from.
`property`	`string` \| `Url`	Property for which to remove the given datetime value.
`value`	`Date`	Datetime to remove from `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/remove.ts:161

removeDecimal#

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

Create a new Thing with the given decimal removed for the given Property.

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 remove a decimal value from.
`property`	`string` \| `Url`	Property for which to remove the given decimal value.
`value`	`number`	Decimal to remove from `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/remove.ts:247

removeInteger#

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

Create a new Thing with the given integer removed for the given Property.

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 remove an integer value from.
`property`	`string` \| `Url`	Property for which to remove the given integer value.
`value`	`number`	Integer to remove from `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/remove.ts:267

removeStringEnglish#

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

Create a new Thing with the given English string removed for the given Property.

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 remove a localised string value from.
`property`	`string` \| `Url`	Property for which to remove the given localised string value.
`value`	`string`	String to remove from `thing` for the given `property`.

Returns#

T

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

Since

1.13.0

Defined in#

src/thing/remove.ts:288

removeStringNoLocale#

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

Create a new Thing with the given unlocalised string removed for the given Property.

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 remove an unlocalised string value from.
`property`	`string` \| `Url`	Property for which to remove the given string value.
`value`	`string`	String to remove from `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/remove.ts:369

removeStringWithLocale#

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

Create a new Thing with the given localised string removed for the given Property.

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 remove a localised string value from.
`property`	`string` \| `Url`	Property for which to remove the given localised string value.
`value`	`string`	String to remove from `thing` for the given `property`.
`locale`	`string`	Locale of the string to remove.

Returns#

T

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

Defined in#

src/thing/remove.ts:307

removeTime#

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

Create a new Thing with the given datetime removed for the given Property.

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 remove a datetime value from.
`property`	`string` \| `Url`	Property for which to remove the given datetime value.
`value`	`Time`	Time to remove from `thing` for the given `property`.

Returns#

T

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

Since

1.10.0

Defined in#

src/thing/remove.ts:214

removeUrl#

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

Create a new Thing with the given URL removed for the given Property.

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 remove a URL value from.
`property`	`string` \| `Url`	Property for which to remove the given URL value.
`value`	`string` \| `Url` \| `ThingPersisted`	URL to remove from `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/remove.ts:84