Returns a future. It is not possible to assign a future to
a collection or add the future to a list. If you do, then nil
will be assigned instead.
If you want to use the return value from a future, you need to use then(..) and errors might be captured using the else(..) function.
A future’s callback will get its own change-Id in case one is required. This means that it is possible to use a future to prevent a change in a query on some conditions (see last example).
This function does not generate a change.
future(request, arg1, arg2, ..., argX)
Argument | Type | Description |
---|---|---|
request | thing/closure/nil (required) | The request or nil for a plain future. A closure can be used as a shortcut for `future(..).then( |
arg1..argX | any (optional) | Arguments which will be used in the result. |
A list with as first value the return value from the optional module or nil
followed by the
future arguments.
This code shows an example usage of future():
future(nil, 42);
Return value in JSON format
[null, 42]
Use a future to prevent a change in some cases:
// dummy condition
condition = 2 > 1;
if (condition) future(|| {
// a change is only required if the condition evaluates to `true`
.only_if_condition = true;
});