Qworum - Qworum for web pages documentation

class Qworum

import { Qworum } from ".";

Web pages can use the Qworum capabilities of web browsers through this JavaScript class.

These are the main methods that Web pages use:

Qworum.eval() evaluates a Qworum script.
Qworum.setData() sets the value of a data container.
Qworum.getData() reads the value of a data container.

Qworum.eval() receives a Qworum script as argument. Here are the methods for generating a Qworum script from in-page JavaScript:

Qworum.Script() creates a Qworum script.
Qworum.Call(), Qworum.Goto(), Qworum.Return(), Qworum.Sequence(), Qworum.Fault(), Qworum.Try() and Qworum.Data() create instructions.
Qworum.Json() and Qworum.SemanticData() create data values.

Other methods:

Qworum.checkAvailability() verifies that a website can use the Qworum capabilities of browsers.

Note: The 📝 sign indicates a function that is used for generating Qworum scripts.

Examples

▶

Checking the browser's Qworum availability status.

try{ await Qworum.checkAvailability(); }catch(error){ console.error('Qworum browser extension not installed or not enabled.'); }

▶

An online shop calls a remote shopping cart service.

await Qworum.eval( Qworum.Script( Qworum.Sequence( Qworum.Call(["@", "shopping cart"], "https://shopping-cart.example/view/"), Qworum.Goto("/home/") ) ) );

▶

Storing data in the current Qworum method call.

await Qworum.setData('year', Qworum.Json(2024));

▶

Reading data stored in the current Qworum method call.

const result = await Qworum.getData(['year']); console.info(JSON.stringify(result.value));

▶

Catching Qworum faults with a try instruction in a Qworum script.

Qworum.Try( Qworum.Call('@', 'checkout/'), [ {catch: ['* the cart is empty'], do: Json({})} ] )

▶

A Qworum fault in a Qworum script (raises a fault when evaluated in a Qworum script).

Qworum.Fault('* payment cancelled')

Static Properties


        Call

📝 Builder for Call instructions.


        Data

📝 Builder for Data instructions.


        Fault

📝 Builder for Fault instructions. Suitable for service-specific faults only.


        Goto

📝 Builder for Goto instructions.


        Json

📝 Builder for Json data values.


        Return

📝 Builder for Return instructions.


        Script

📝 Builder for Qworum scripts.


        SemanticData

📝 Builder for semantic data values.


        Sequence

📝 Builder for Sequence instructions.

Try

📝 Builder function for Try instructions.


        message: { GenericData; DataValue; Json; SemanticData; Instruction; Data; Return; Sequence; Goto; Call; Fault; FaultTypeError; PlatformFault; PlatformFaultTypeError; Try; Script; PhaseParameters;  }

Classes representing Qworum instructions and Qworum data.


        version: string

The version of this JavaScript library.

Static Methods


        checkAvailability()

Checks that:

the Qworum browser extension is installed and running, and
the website's origin is part of Qworum's Service Web.


        eval(script)

Evaluates a Qworum script.

The outcome is one of:

Redirection to a new URL (the current Qworum session continues).
Closing of the browser tab after displaying an alert window (the current Qworum session has terminated).


        getData(path)

Reads a value contained in a data container.


        setData(path, value)

Sets the value contained in a data container.