@inrupt/solid-client / thing/remove
Module: thing/remove¶
Table of contents¶
Functions¶
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 |
---|---|
|
Parameters:¶
Name |
Type |
Description |
---|---|---|
|
T |
Thing to remove values from. |
|
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¶
▸ Const
removeBoolean<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 |
---|---|
|
Parameters:¶
Name |
Type |
Description |
---|---|---|
|
T |
Thing to remove a boolean value from. |
|
string | Url |
Property for which to remove the given boolean value. |
|
boolean |
Boolean to remove from |
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¶
▸ Const
removeDatetime<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 |
---|---|
|
Parameters:¶
Name |
Type |
Description |
---|---|---|
|
T |
Thing to remove a datetime value from. |
|
string | Url |
Property for which to remove the given datetime value. |
|
Date |
Datetime to remove from |
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¶
▸ Const
removeDecimal<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 |
---|---|
|
Parameters:¶
Name |
Type |
Description |
---|---|---|
|
T |
Thing to remove a decimal value from. |
|
string | Url |
Property for which to remove the given decimal value. |
|
number |
Decimal to remove from |
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¶
▸ Const
removeInteger<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 |
---|---|
|
Parameters:¶
Name |
Type |
Description |
---|---|---|
|
T |
Thing to remove an integer value from. |
|
string | Url |
Property for which to remove the given integer value. |
|
number |
Integer to remove from |
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¶
▸ Const
removeStringNoLocale<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 |
---|---|
|
Parameters:¶
Name |
Type |
Description |
---|---|---|
|
T |
Thing to remove an unlocalised string value from. |
|
string | Url |
Property for which to remove the given string value. |
|
string |
String to remove from |
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 |
---|---|
|
Parameters:¶
Name |
Type |
Description |
---|---|---|
|
T |
Thing to remove a localised string value from. |
|
Property for which to remove the given localised string value. |
|
|
string |
String to remove from |
|
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¶
▸ Const
removeUrl<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 |
---|---|
|
Parameters:¶
Name |
Type |
Description |
---|---|---|
|
T |
Thing to remove a URL value from. |
|
string | Url |
Property for which to remove the given URL value. |
|
string | Url | ThingPersisted |
URL to remove from |
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