Should deprecate/deprecated be included in the docs and types?

[natasha-audrey]

yargs/yargs.js

Line 636 in 8aae333

const deprecate = opt.deprecate || opt.deprecated

I see this was added in #1559 (added in v15.2.0) - but I don't see it listed in the docs in option's documentation or in @types/yargs@15.0.5.

It would be nice to use in my typescript project without a @ts-ignore

---

Relevant issue: #1518

[bcoe]

@NathanYocum we've opted to not ship types for yargs, so to add this to the type definition I suggest creating an issue on the @types/yargs definition in definitely typed.

I agree we should definitely document this feature in the API, if it hasn't been 😄

I would happily take a patch for this.