@inrupt/solid-client / thing/get

Module: thing/get

Functions

getBoolean

getBoolean(thing: Thing, property: Url | UrlString): boolean | null

Parameters:

Name

Type

Description

thing

Thing

The Thing to read a boolean value from.

property

Url | UrlString

The given Property for which you want the boolean value.

Returns: boolean | null

A boolean value for the given Property, if present, or null otherwise.

Defined in: src/thing/get.ts:87


getBooleanAll

getBooleanAll(thing: Thing, property: Url | UrlString): boolean[]

Parameters:

Name

Type

Description

thing

Thing

The Thing to read the boolean values from.

property

Url | UrlString

The given Property for which you want the boolean values.

Returns: boolean[]

The boolean values for the given Property.

Defined in: src/thing/get.ts:110


getDatetime

getDatetime(thing: Thing, property: Url | UrlString): Date | null

Parameters:

Name

Type

Description

thing

Thing

The Thing to read a datetime value from.

property

Url | UrlString

The given Property for which you want the datetime value.

Returns: Date | null

A datetime value for the given Property, if present, or null otherwise.

Defined in: src/thing/get.ts:131


getDatetimeAll

getDatetimeAll(thing: Thing, property: Url | UrlString): Date[]

Parameters:

Name

Type

Description

thing

Thing

The Thing to read the datetime values from.

property

Url | UrlString

The given Property for which you want the datetime values.

Returns: Date[]

The datetime values for the given Property.

Defined in: src/thing/get.ts:154


getDecimal

getDecimal(thing: Thing, property: Url | UrlString): number | null

Parameters:

Name

Type

Description

thing

Thing

The Thing to read a decimal value from.

property

Url | UrlString

The given Property for which you want the decimal value.

Returns: number | null

A decimal value for the given Property, if present, or null otherwise.

Defined in: src/thing/get.ts:175


getDecimalAll

getDecimalAll(thing: Thing, property: Url | UrlString): number[]

Parameters:

Name

Type

Description

thing

Thing

The Thing to read the decimal values from.

property

Url | UrlString

The given Property for which you want the decimal values.

Returns: number[]

The decimal values for the given Property.

Defined in: src/thing/get.ts:198


getInteger

getInteger(thing: Thing, property: Url | UrlString): number | null

Parameters:

Name

Type

Description

thing

Thing

The Thing to read an integer value from.

property

Url | UrlString

The given Property for which you want the integer value.

Returns: number | null

An integer value for the given Property, if present, or null otherwise.

Defined in: src/thing/get.ts:219


getIntegerAll

getIntegerAll(thing: Thing, property: Url | UrlString): number[]

Parameters:

Name

Type

Description

thing

Thing

The Thing to read the integer values from.

property

Url | UrlString

The given Property for which you want the integer values.

Returns: number[]

The integer values for the given Property.

Defined in: src/thing/get.ts:242


getStringByLocaleAll

getStringByLocaleAll(thing: Thing, property: Url | UrlString): Map<string, string[]>

Retrieves all language string literals for the specified property from the specified Thing (explicitly filters out non-language string literals).

Parameters:

Name

Type

Description

thing

Thing

The Thing to read the localised string values from.

property

Url | UrlString

The given Property for which you want the localised string values.

Returns: Map<string, string[]>

A Map of objects, keyed on locale with the value an array of string values (for that locale).

Defined in: src/thing/get.ts:308


getStringNoLocale

getStringNoLocale(thing: Thing, property: Url | UrlString): string | null

Parameters:

Name

Type

Description

thing

Thing

The Thing to read a string value from.

property

Url | UrlString

The given Property for which you want the string value.

Returns: string | null

A string value for the given Property, if present, or null otherwise.

Defined in: src/thing/get.ts:336


getStringNoLocaleAll

getStringNoLocaleAll(thing: Thing, property: Url | UrlString): string[]

Parameters:

Name

Type

Description

thing

Thing

The Thing to read the string values from.

property

Url | UrlString

The given Property for which you want the string values.

Returns: string[]

The string values for the given Property.

Defined in: src/thing/get.ts:355


getStringWithLocale

getStringWithLocale(thing: Thing, property: Url | UrlString, locale: string): string | null

Parameters:

Name

Type

Description

thing

Thing

The Thing to read a localised string value from.

property

Url | UrlString

The given Property for which you want the localised string value.

locale

string

The desired locale for the string value.

Returns: string | null

A localised string value for the given Property, if present in locale, or null otherwise.

Defined in: src/thing/get.ts:264


getStringWithLocaleAll

getStringWithLocaleAll(thing: Thing, property: Url | UrlString, locale: string): string[]

Parameters:

Name

Type

Description

thing

Thing

The Thing to read the localised string values from.

property

Url | UrlString

The given Property for which you want the localised string values.

locale

string

The desired locale for the string values.

Returns: string[]

The localised string values for the given Property.

Defined in: src/thing/get.ts:287


getUrl

getUrl(thing: Thing, property: Url | UrlString): UrlString | null

Parameters:

Name

Type

Description

thing

Thing

The Thing to read a URL value from.

property

Url | UrlString

The given Property for which you want the URL value.

Returns: UrlString | null

A URL value for the given Property, if present, or null otherwise.

Defined in: src/thing/get.ts:45


getUrlAll

getUrlAll(thing: Thing, property: Url | UrlString): UrlString[]

Parameters:

Name

Type

Description

thing

Thing

The Thing to read the URL values from.

property

Url | UrlString

The given Property for which you want the URL values.

Returns: UrlString[]

The URL values for the given Property.

Defined in: src/thing/get.ts:68