A query (spec 5 §5). More...

#include <document.hpp>

Public Attributes
std::string	name
	The name.
std::string	path
	The declaration's JSON Pointer.
std::string	model
	The model alias it goes through.
std::string	action
	The action id it runs, or evaluates.
bool	evaluate = false
	Whether it is an evaluate of the action (spec 5 §7) rather than a call.
ExprPtr	body
	The body, which is the query's key; nullptr sends an empty object.
ExprPtr	when
	The gate; nullptr is always on.
std::int64_t	debounce = 0
	Milliseconds the key must be stable before a fetch.
std::int64_t	refreshEvery = 0
	Milliseconds between polls; 0 does not poll.
std::int64_t	staleTime = 0
	Milliseconds a cached value counts as fresh.

Detailed Description

A query (spec 5 §5).

Definition at line 193 of file document.hpp.

Member Data Documentation

◆ name

std::string morph::ui::QueryDecl::name

The name.

Definition at line 195 of file document.hpp.

◆ path

std::string morph::ui::QueryDecl::path

The declaration's JSON Pointer.

Definition at line 197 of file document.hpp.

◆ model

std::string morph::ui::QueryDecl::model

The model alias it goes through.

Definition at line 199 of file document.hpp.

◆ action

std::string morph::ui::QueryDecl::action

The action id it runs, or evaluates.

Definition at line 201 of file document.hpp.

◆ evaluate

bool morph::ui::QueryDecl::evaluate = false

Whether it is an evaluate of the action (spec 5 §7) rather than a call.

Definition at line 203 of file document.hpp.

◆ body

ExprPtr morph::ui::QueryDecl::body

The body, which is the query's key; nullptr sends an empty object.

Definition at line 205 of file document.hpp.

◆ when

ExprPtr morph::ui::QueryDecl::when

The gate; nullptr is always on.

Definition at line 207 of file document.hpp.

◆ debounce

std::int64_t morph::ui::QueryDecl::debounce = 0

Milliseconds the key must be stable before a fetch.

Definition at line 209 of file document.hpp.

◆ refreshEvery

std::int64_t morph::ui::QueryDecl::refreshEvery = 0

Milliseconds between polls; 0 does not poll.

Definition at line 211 of file document.hpp.

◆ staleTime

std::int64_t morph::ui::QueryDecl::staleTime = 0

Milliseconds a cached value counts as fresh.

Definition at line 213 of file document.hpp.

The documentation for this struct was generated from the following file:

morph/ui/document.hpp

Public Attributes