lowdefy/packages/docs/operators/_request.yaml
2021-01-28 11:38:15 +02:00

36 lines
1.2 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: _request
pageTitle: _request
types: |
```
(requestId: string): any
```
description: |
The `_request` operator returns the response value of a request. If the request has not yet been call, or is still executing, the returned value is `null`.
arguments: |
###### string
The id of the request.
examples: |
###### Using a request response:
```yaml
_request: my_request
```
Returns: The response returned by the request.