lowdefy/packages/docs/operators/_eq.yaml

67 lines
1.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: _eq
pageTitle: _eq
types: |
```
([value1: any, value2: any]): boolean
```
description: |
The `_eq` operator tests if two values are equal. It takes an array of two values to test.
> The `_eq` operator tests for strict equality, and won't do a deep comparison.
arguments: |
###### array
An array of two values to compare.
examples: |
###### Two strings:
```yaml
_eq:
- "Hello"
- "Hello"
```
Returns: `true`
###### Two numbers:
```yaml
_eq:
- _sum:
- 3
- 4
- 8
```
Returns: `false`
###### Arrays are not compared deeply:
```yaml
_eq:
- [1,2,3]
- [1,2,3]
```
Returns: `false`
###### Values from "getter" operators are copies and not equal:
```yaml
_eq:
- _state: my_object
- _state: my_object
```
Returns: `false`