# 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: _sum
    pageTitle: _sum
    types: |
      ```
      (values: any[]): number
      ```
    description: |
      The `_sum` operator takes the sum of the values given as input. If a value is not a number, the value is skipped.
    arguments: |
      #### array
      An array of values to add.
    examples: |
      ###### Two numbers:
      ```yaml
      _sum:
        - 3
        - 4
      ```
      Returns: `7`

      ###### Array of numbers:
      ```yaml
      _sum:
        - 1
        - 2
        - 3
        - 4
      ```
      Returns: `10`

      ###### Non-numbers are skipped:
      ```yaml
      _sum:
        - 1
        - null
        - 3
        - "four"
        - 5
      ```
      Returns: `9`