Module: thing/remove¶

Table of contents¶

Functions¶

removeAll¶

▸ removeAll<T>(thing: T, property: Url | UrlString): 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`	Thing

Parameters:¶

Name	Type	Description
`thing`	T	Thing to remove values from.
`property`	Url \| UrlString	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:58

removeBoolean¶

▸ ConstremoveBoolean<T>(thing: T, property: string | Url, value: boolean): 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`	Thing

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

removeDatetime¶

▸ ConstremoveDatetime<T>(thing: T, property: string | Url, value: Date): 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`	Thing

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

removeDecimal¶

▸ ConstremoveDecimal<T>(thing: T, property: string | Url, value: number): 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`	Thing

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

removeInteger¶

▸ ConstremoveInteger<T>(thing: T, property: string | Url, value: number): 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`	Thing

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

removeStringNoLocale¶

▸ ConstremoveStringNoLocale<T>(thing: T, property: string | Url, value: string): 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`	Thing

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

removeStringWithLocale¶

▸ removeStringWithLocale<T>(thing: T, property: Url | UrlString, value: string, locale: string): 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`	Thing

Parameters:¶

Name	Type	Description
`thing`	T	Thing to remove a localised string value from.
`property`	Url \| UrlString	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:215

removeUrl¶

▸ ConstremoveUrl<T>(thing: T, property: string | Url, value: string | Url | ThingPersisted): 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`	Thing

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

Module: thing/mock Module: thing/set