API Reference / @gtkx/runtime / toVariant

Function: toVariant()

toVariant<S>(typeString, value): Variant

Defined in: packages/runtime/src/variant.ts:496

Packs a JavaScript value into a GLib.Variant described by a GVariant type string. Literal type strings also determine the TypeScript input type: "as" takes strings, "a{sv}" a record of variants, "(si)" a string/number pair, 64-bit types a bigint, and "ay" a Uint8Array or byte array. Nested arrays, dictionaries, tuples, and maybes are supported.

Type Parameters

S

S extends string

Parameters

typeString

S

One complete GVariant type, such as "a{sv}".

value

ParsedValue<S>

Value matching that type.

Returns

Variant

The packed variant.

Throws

For invalid types, object paths, or signatures, or byte-array inputs other than a Uint8Array or an array of byte values.