Usage command builder function incorrectly documented

[H0R5E]

Hi, I am trying to use the usage command as a default alias as described in the docs here, using typescript as follows:

#!/usr/bin/env node

import yargs from 'yargs/yargs';

const argv = yargs(process.argv.slice(2))
  .usage('$0 <port>', 'start the application server', (yargs) => {
    yargs.positional('port', {
      describe: 'the port that your application should bind to',
      type: 'number'
    })
  }).parseSync()

console.log(argv)

However, when I go to compile this, I get the following error:

blah - error TS2769: No overload matches this call.
  The last overload gave the following error.
    Argument of type 'string' is not assignable to parameter of type 'boolean'.

6   .usage('$0 <port>', 'start the application server', (yargs) => {
                        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  node_modules/@types/yargs/index.d.ts:637:9
    637         usage<O extends { [key: string]: Options }>(
                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    638             command: string | ReadonlyArray<string>,
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    ...
    641             handler?: (args: ArgumentsCamelCase<InferredOptionTypes<O>>) => void | Promise<void>,
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    642         ): Argv<T>;
        ~~~~~~~~~~~~~~~~~~~
    The last overload is declared here.

EDIT: the yargs version is 17.7.1

Any help is greatly appreciated.

Best wishes,

Mat

[shadowspawn]

Thanks for the complete example application. The TypeScript definition expects the builder function to return the freshly configured yargs instance. Here, I have just added a return in your builder function.

const argv = yargs(process.argv.slice(2))
  .usage('$0 <port>', 'start the application server', (yargs) => {
    return yargs.positional('port', {
      describe: 'the port that your application should bind to',
      type: 'number'
    })
  }).parseSync()

[shadowspawn]

(I think the example in the documentation for usage is missing the return.)

[H0R5E]

Here, I have just added a return in your builder function.

Thanks, works for me!