lowdefy/packages/docs/operators/_gte.yaml
2021-02-11 19:09:10 +02:00

66 lines
1.7 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: _gte
pageTitle: _gte
filePath: operators/_gte.yaml
types: |
```
([value1: any, value2: any]): boolean
```
description: |
The `_gte` operator tests if the first value is greater than or equal to the second equal. It takes an array of two values to test.
> The `_gte` operator tests using the javascript greater than or equal operator. You can find a description of the algorithm used to compare two values [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Less_than).
arguments: |
###### array
An array of two values to compare.
examples: |
###### Two numbers:
```yaml
_gte:
- 4
- 3
```
Returns: `true`
```yaml
_gte:
- 1
- 1
```
Returns: `true`
```yaml
_gte:
- _sum:
- 3
- 4
- 8
```
Returns: `false`
###### Two strings:
```yaml
_gte:
- "a"
- "b"
```
Returns: `false`