File size: 1,350 Bytes
06227db | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | declare namespace yn {
interface Options {
/**
Use a key distance-based score to leniently accept typos of `yes` and `no`.
@default false
*/
readonly lenient?: boolean;
/**
Default value if no match was found.
@default null
*/
readonly default?: boolean | null;
}
interface OptionsWithDefault extends Options {
default: boolean;
}
}
declare const yn: {
/**
Parse yes/no like values.
The following case-insensitive values are recognized: `'y', 'yes', 'true', true, '1', 1, 'n', 'no', 'false', false, '0', 0`
@param input - Value that should be converted.
@returns The parsed input if it can be parsed or the default value defined in the `default` option.
@example
```
import yn = require('yn');
yn('y');
//=> true
yn('NO');
//=> false
yn(true);
//=> true
yn('abomasum');
//=> null
yn('abomasum', {default: false});
//=> false
yn('mo', {lenient: true});
//=> false
```
*/
(input: unknown, options: yn.OptionsWithDefault): boolean;
(input: unknown, options?: yn.Options): boolean | null;
// TODO: Remove this for the next major release, refactor the whole definition to:
// declare function yn(input: unknown, options: yn.OptionsWithDefault): boolean;
// declare function yn(input: unknown, options?: yn.Options): boolean | null;
// export = yn;
default: typeof yn;
};
export = yn;
|