The appveyor-status command.
(require("appveyor-status/bin/appveyor-status"))(argsnon-null, optionsopt, callbackopt, nullable) → {Promise.<module:appveyor-status/bin/appveyor-status.ExitCode>|undefined}
Entry point for this command.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
args |
Array.<string> | Command-line arguments. | |
options |
module:appveyor-status/bin/appveyor-status.CommandOptions |
<optional> |
Options. |
callback |
function |
<optional> <nullable> |
Callback for the exit code
or an Error. Required if global.Promise is
not defined. |
- Source:
Returns:
If
callback is not given and
global.Promise is defined, a Promise with the
exit code or Error.
- Type
- Promise.<module:appveyor-status/bin/appveyor-status.ExitCode> | undefined
- Copyright:
- Copyright 2017-2019 Kevin Locke
- Copyright 2017-2019 Kevin Locke
- License:
- MIT
- Source:
Members
(static, constant) ExitCode :number
Exit codes returned by module:appveyor-status/bin/appveyor-status
(as a bi-directional map).
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
SUCCESS |
number | Success. |
FAIL_OTHER |
number | Failed for an unspecified reason. |
FAIL_STATUS |
number | Failed due to build status. |
FAIL_COMMIT |
number | Failed due to commit mismatch. |
FAIL_ARGUMENTS |
number | Failed due to invalid arguments. |
- Source:
Type Definitions
CommandOptions
Options for command entry points.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
in |
module:stream.Readable |
<optional> |
Stream from which input is read.
(default: process.stdin) |
out |
module:stream.Writable |
<optional> |
Stream to which output is written.
(default: process.stdout) |
err |
module:stream.Writable |
<optional> |
Stream to which errors (and
non-output status messages) are written.
(default: process.stderr) |
- Source: