Api Change Run
Listen an URL change and trigger a command run on change.
Install
The api-change-run package can be installed as devDependencies:
# NPM:
npm install --save-dev api-change-run
# NPM:
yarn add --dev api-change-runor run directly using npx command:
npx api-change-run --helpapi-change-run
The api-change-run CLI is polling a given URL to detect changes.
The main purpose is to execute a command when a Rest API response changes.
Note: The alias
api-change-pollCLI can be used when the package is locally installed.
Usage
npx api-change-run --help
# Usage: api-change-run [options] <command>
# Execute commands on API change
# Arguments:
# command Command to execute
# Options:
# -V, --version output the version number
# -u, --uri <URI> URL to the API to watch
# -d --delay <number> Delay between polling in second (default: 200)
# --cwd <path> Current working directory (default: process.cwd())
# -a, --access-token <token> Access Token to be used as Bearer token
# -l, --login-url <url> Basic authentication URL to call to retrieve access token (ex: http://me:pwd@localhost/api)
# -b, --basic-auth <user:password> Use Basic Authentication to contact the API
# -i, --init Trigger a run on the initial connection
# -s --script Indicate that the given argument is a script that need to be run with npm (or yarn)
# -v, --verbose Current working directory
# -h, --help display help for commandCommand
The command will be executed via Node child process.
The response content of the call can be referred in the command via the template string ${RESPONSE} as following:
npx api-change-run --uri http://localhost/api "echo 'the response `${RESPONSE}'"If the options --script is provided, the command will be handle as NPM script and will will be executed with npm run <command> (or yarn run <command>).
npx api-change-run --uri http://localhost/api --script test
# will execute `npm run test`
yarn dlx api-change-run --uri http://localhost/api --script test
# will execute `yarn run test`Authentification
The api-change-run command supports support call requiring authentication via Bearer Token.
To activate the identification 2 options can be provided:
- Providing the Token to use via the option
--access-token. - Providing the URI to connect via Basic Auth to retrieve the access_token information via
--basic-auth.