API Reference / @gtkx/runtime / getProperty

Function: getProperty()

Call Signature

getProperty<TObject, TPropertyMap, TName>(obj, propertyName): NoInfer<TPropertyMap>[TName]

Defined in: packages/runtime/dist/object.d.ts:58

Reads a GObject property and converts it to its JavaScript value using the descriptor.

Type Parameters

TObject

TObject extends object

TPropertyMap

TPropertyMap extends object = TObject extends object ? TResolver extends () => TMap ? Extract<NonNullable<TMap>, object> : TObject["__properties__"] : TObject["__properties__"]

TName

TName extends string = Extract<NoInfer<keyof TPropertyMap>, string>

Parameters

obj

TObject

The object to read from.

propertyName

TName

The property name.

Returns

NoInfer<TPropertyMap>[TName]

Call Signature

getProperty(obj, propertyName, descriptor): unknown

Defined in: packages/runtime/dist/object.d.ts:63

Reads a GObject property and converts it to its JavaScript value using the descriptor.

Parameters

obj

object

The object to read from.

propertyName

string

The property name.

descriptor

Descriptor

Describes the property's type.

Returns

unknown