mirror of
https://github.com/lowdefy/lowdefy.git
synced 2025-02-17 14:30:34 +08:00
1f928d93db
BREAKING CHANGE: The _event, _global, _input, _state, and _url_query operators are no longer evaluated in connections or requests.
108 lines
3.6 KiB
YAML
108 lines
3.6 KiB
YAML
# Copyright 2020-2021 Lowdefy, Inc
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
_ref:
|
|
path: templates/operators.yaml.njk
|
|
transformer: templates/operatorsMethodTransformer.js
|
|
vars:
|
|
pageId: _global
|
|
pageTitle: _global
|
|
filePath: operators/_global.yaml
|
|
env: Client Only
|
|
types: |
|
|
```
|
|
(key: string): any
|
|
(all: boolean): any
|
|
(arguments: {
|
|
all?: boolean,
|
|
key?: string,
|
|
default?: any,
|
|
contextId?: string
|
|
}): any
|
|
```
|
|
description: |
|
|
The `_global` operator gets a value from the [`global`](/context-and-state) object. The `global` object is a shared data object that can be accessed from any `context` in the app.
|
|
|
|
arguments: |
|
|
###### string
|
|
If the `_global` operator is called with a string argument, the value of the key in the `global` object is returned. If the value is not found, `null` is returned. Dot notation and [block list indexes](/lists) are supported.
|
|
|
|
###### boolean
|
|
If the `_global` operator is called with boolean argument `true`, the entire `global` object is returned.
|
|
|
|
###### object
|
|
- `all: boolean`: If `all` is set to `true`, the entire `global` object is returned. One of `all` or `key` are required.
|
|
- `key: string`: The value of the key in the `global` object is returned. If the value is not found, `null`, or the specified default value is returned. Dot notation and [block list indexes](/lists) are supported. One of `all` or `key` are required.
|
|
- `default: any`: A value to return if the `key` is not found in `global`. By default, `null` is returned if a value is not found.
|
|
- `contextId: string`: The id of a `context`. Setting this will get the value from the `context` of the specified context. A list of `contexts` that exist are returned by the [`_list_contexts`](/_list_contexts) operator. The value of `global` is the same for all `contexts`. Cannot be used in `connections` or `requests`.
|
|
|
|
examples: |
|
|
###### Get the value of `my_key` from `global`:
|
|
```yaml
|
|
_global: my_key
|
|
```
|
|
```yaml
|
|
_global:
|
|
key: my_key
|
|
```
|
|
Returns: The value of `my_key` in `global`.
|
|
|
|
###### Get the entire `global` object:
|
|
```yaml
|
|
_global: true
|
|
```
|
|
```yaml
|
|
_global:
|
|
all: true
|
|
```
|
|
Returns: The entire `global` object.
|
|
|
|
###### Dot notation:
|
|
Assuming global:
|
|
```yaml
|
|
my_object:
|
|
subfield: 'Value'
|
|
```
|
|
then:
|
|
```yaml
|
|
_global: my_object.subfield
|
|
```
|
|
```yaml
|
|
_global:
|
|
key: my_object.subfield
|
|
```
|
|
Returns: `"Value"`.
|
|
|
|
###### Return a default value if the value is not found:
|
|
```yaml
|
|
_global:
|
|
key: might_not_exist
|
|
default: Default value
|
|
```
|
|
Returns: The value of `might_not_exist`, or `"Default value"`.
|
|
|
|
###### Block list indices:
|
|
Assuming `global`:
|
|
```yaml
|
|
my_array:
|
|
- value: 0
|
|
- value: 1
|
|
- value: 2
|
|
```
|
|
then:
|
|
```yaml
|
|
_global: my_array.$.value
|
|
```
|
|
Returns: `0` when used from the first block (0th index) in a list.
|