Skip to content

Commit

Permalink
Update packages/core/README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Thomas Boop <52323235+thboop@users.noreply.github.com>
  • Loading branch information
yi-Xu-0100 and thboop authored Apr 28, 2021
1 parent dc9ec8f commit 2e7a5bb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import * as core from '@actions/core';

#### Inputs/Outputs

Action inputs can be read with `getInput` meanwhile the return type is `string`, and the inputs of the boolean type in the [YAML 1.2 "Core Schema" specification](https://yaml.org/spec/1.2/spec.html#id2804923) can be read with `getBooleanInput` meanwhile the return type is `boolean`. Outputs can be set with `setOutput` which makes them available to be mapped into inputs of other actions to ensure they are decoupled.
Action inputs can be read with `getInput` which returns a `string` or `getBooleanInput` which parses a boolean based on the [yaml 1.2 specification](https://yaml.org/spec/1.2/spec.html#id2804923). Outputs can be set with `setOutput` which makes them available to be mapped into inputs of other actions to ensure they are decoupled.

```js
const myInput = core.getInput('inputName', { required: true });
Expand Down

0 comments on commit 2e7a5bb

Please sign in to comment.