Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
yargs-promise
Advanced tools
Readme
Use the headless yargs parser with promises!
npm
npm install --save yargs-promise
yarn
yarn add --save yargs-promise
Instead of using a callback with yargs.parse, use a promise chain: parser.parse(text).then().catch()
.
Examples:
const yargs = require('yargs');
const YargsPromise = require('yargs-promise');
// create the customized yargs parser
const parser = new YargsPromise(yargs);
// setup command & command handler
parser
.command('hello <name>', 'hello world parser' , ()=>{}, (argv) => {
// resolve a promise or other value
argv.resolve(doSomething);
// reject stuff
argv.reject(yourErrorData);
// or do nothing and reject/resolve will be handled internally
console.log('testing argv');
})
.help();
// parse text input and use the returned promise
parser.parse('hello world')
.then(({data, argv}) => {
// data is what your code resolved or what an internal command resolved
})
.catch(({error, argv}) => {
// `error` is what your code rejected or an internal error from yargs
});
Customizing context example
const yargs = require('yargs');
const YargsPromise = require('yargs-promise');
const parser = new YargsPromise(
yargs,
// customize context
{
customContextMethod: () => {},
foo: 'bar'
}
);
parser
.command('hello <name>', 'hello world parser' , ()=>{}, (argv) => {
// argv now contains
argv.customContextMethod();
console.log(argv.foo);
})
.help();
Need access to yargs object? Work with the direct yargs
object prior to passing it into the yargs-promise constructor. For convenience, it is also available at parser.yargs
.
This library does three things:
resolve
& reject
methods on the context passed to yargs.parse
argv.resolve
or argv.reject
in command handler function.help()
Checkout the source code or tests for more information.
Building chatbots requires parsing and handling text input. This wraps up the most common needs I've come across for handling errors, simple commands, and commands with handlers.
FAQs
Use the headless yargs parser with promises
We found that yargs-promise demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.