@lowdefy/docs 3.23.3 → 4.0.0-alpha.11

package/operators/_json.yaml

@@ -1,128 +0,0 @@
-# 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: _json
-    pageTitle: _json
-    filePath: operators/_json.yaml
-    description: |
-      The `_json` parses and writes JSON strings.
-    methods:
-      - name: parse
-        types: |
-          ```
-          (value: string): any
-          ```
-        description: |
-          The `_json.parse` method parses a JSON string into an object.
-        arguments: |
-          ###### string
-          The string to parse.
-        examples: |
-          ###### Parse a JSON string:
-          ```yaml
-          _json.parse: '{"key": "Value", "boolean": true, "array": [1, 2]}'
-          ```
-          Returns:
-          ```
-          key: Value
-          boolean: true
-          array:
-            - 1
-            - 2
-          ```
-      - name: stringify
-        types: |
-          ```
-          ({on: any, options?: object}): string
-          ([on: any, options?: object]): string
-          ```
-        description: |
-          The `_json.stringify` method creates a JSON string from an object.
-        arguments: |
-          ###### object
-            - `on: any`: The object to stringify.
-            - `options: object`: Optional settings.
-              - `stable: boolean`: If set to true, equal objects will be stringified to the same string. Object keys are sorted.
-              - `space: number | string`: Used to insert whitespace to increase legibility. If a number, it is the number of space character to use. If a string, the string is used as whitespace. The default is `2`.
-
-        examples: |
-          ###### Stringify an object as JSON:
-          ```yaml
-          _json.stringify:
-            on:
-              key: Value
-              boolean: true
-              array:
-                - 1
-                - 2
-          ```
-          ```yaml
-          _json.stringify:
-            - key: Value
-              boolean: true
-              array:
-                - 1
-                - 2
-          ```
-          Returns (as a string):
-          ```text
-          '{
-            "key": "Value",
-            "boolean": true,
-            "array": [
-              1,
-              2
-            ]
-          }'
-          ```
-          ###### Stable option:
-          ```yaml
-          _json.stringify:
-            on:
-              key: Value
-              boolean: true
-              array:
-                - 1
-                - 2
-            options:
-              stable: true
-          ```
-          Returns (as a string):
-          ```text
-          '{
-            "array": [
-              1,
-              2
-            ],
-            "boolean": true,
-            "key": "Value"
-          }''
-          ```
-          ###### Space option:
-          ```yaml
-          _json.stringify:
-            on:
-              key: Value
-              boolean: true
-              array:
-                - 1
-                - 2
-            options:
-              space: 0
-          ```
-          Returns `'{"key":"Value","boolean":true,"array":[1,2]}'`

package/operators/_list_contexts.yaml

@@ -1,37 +0,0 @@
-# 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: _list_contexts
-    pageTitle: _list_contexts
-    filePath: operators/_list_contexts.yaml
-    env: Client Only
-    types: |
-      ```
-      (value: any): string[]
-      ```
-    description: |
-      The `_list_contexts` operator returns an array with the ids of all the `contexts` already mounted during the current user session in the app. The operator can only be used in the web-client, and not in `connections` or `requests`.
-    arguments: |
-      ###### any
-      The `_list_contexts` operator returns the array regardless of arguments.
-    examples: |
-      ###### List all context ids:
-      ```yaml
-      _list_contexts: true
-      ```
-      Returns: An array of all `context` ids.

package/operators/_location.yaml

@@ -1,59 +0,0 @@
-# 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: _location
-    pageTitle: _location
-    filePath: operators/_location.yaml
-    env: Client Only
-    types: |
-      ```
-      (key: string): any
-      ```
-    description: |
-      The `_location` operator gets a value from the browser [Location](https://developer.mozilla.org/en-US/docs/Web/API/Location) interface. The Location interface represents the location (URL) of the window object it is linked to, thus can return the URL elements of the current window. It can only be used on the web-client (Not in `requests` or `connections`).
-
-      The following location properties are available.
-      - `basePath: string`: The application base path setting.
-      - `hash: string`: A string containing a '#' followed by the fragment identifier of the URL.
-      - `host: string`: A string containing the host, that is the hostname, a `:`, and the port of the URL.
-      - `hostname: string`: The domain of the URL.
-      - `homePageId: string`: The home page id.
-      - `href: string`: The entire URL string.
-      - `origin: string`: The canonical form of the origin of the specific location.
-      - `pageId: string`: The current page id.
-      - `pathname: string`: A string containing an initial `/`` followed by the path of the URL, not including the query string or fragment.
-      - `port: string`: The port number of the URL
-      - `protocol: string`: The protocol scheme of the URL, mostly `http:` or `https:`.
-      - `search: string`: A string containing a '?' followed by the parameters or "querystring" of the URL.
-
-    arguments: |
-      ###### string
-      If called with a string argument, the value of the key in the `location` object is returned. If the value is defined, `null` is returned.
-
-    examples: |
-      ###### Get the `origin` from `location`:
-      ```yaml
-      _location: origin
-      ```
-      Returns: The current `window.location.origin`, in this case 'https://docs.lowdefy.com'.
-
-      ###### Get the `pathname` from `location`:
-      ```yaml
-      _location: pathname
-      ```
-      Returns: The current `window.location.pathname`, in this case '/_location'.

package/operators/_log.yaml

@@ -1,36 +0,0 @@
-# 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: _log
-    pageTitle: _log
-    filePath: operators/_log.yaml
-    types: |
-      ```
-      (value: any): any
-      ```
-    description: |
-      The `_log` operator logs it input to the console, and returns the value it received. Since it returns the value it received, it can be used to debug without affecting the rest of the configuration.
-    arguments: |
-      ###### any
-    examples: |
-      ###### Log the results of a request to the console:
-      ```yaml
-      _log:
-        _request: my_request
-      ```
-      Returns: The value of the request

package/operators/_lt.yaml

@@ -1,65 +0,0 @@
-# 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: _lt
-    pageTitle: _lt
-    filePath: operators/_lt.yaml
-    types: |
-      ```
-      ([value1: any, value2: any]): boolean
-      ```
-    description: |
-      The `_lt` operator tests if the first value is less than the second equal. It takes an array of two values to test.
-
-      > The `_lt` operator tests using the javascript less than 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
-      _lt:
-        - 4
-        - 3
-      ```
-      Returns: `false`
-
-      ```yaml
-      _lt:
-        - 1
-        - 1
-      ```
-      Returns: `false`
-
-      ```yaml
-      _lt:
-        - _sum:
-            - 3
-            - 4
-        - 8
-      ```
-      Returns: `true`
-
-      #### Two strings:
-      ```yaml
-      _lt:
-        - "a"
-        - "b"
-      ```
-      Returns: `true`

package/operators/_lte.yaml

@@ -1,65 +0,0 @@
-# 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: _lte
-    pageTitle: _lte
-    filePath: operators/_lte.yaml
-    types: |
-      ```
-      ([value1: any, value2: any]): boolean
-      ```
-    description: |
-      The `_lte` operator tests if the first value is less than or equal to the second equal. It takes an array of two values to test.
-
-      > The `_lte` operator tests using the javascript less than or equal to 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
-      _lte:
-        - 4
-        - 3
-      ```
-      Returns: `false`
-
-      ```yaml
-      _lte:
-        - 1
-        - 1
-      ```
-      Returns: `true`
-
-      ```yaml
-      _lte:
-        - _sum:
-            - 3
-            - 4
-        - 8
-      ```
-      Returns: `true`
-
-      ###### Two strings:
-      ```yaml
-      _lte:
-        - "a"
-        - "b"
-      ```
-      Returns: `true`