fix: add overloads to enum flag

oclif · Aug 18, 2022 · 799455b · 799455b
1 parent ff23aa8
commit 799455b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/flags.ts b/src/flags.ts
@@ -1,4 +1,4 @@
-import {OptionFlag, Definition, BooleanFlag, EnumFlagOptions} from './interfaces'
+import {OptionFlag, Definition, BooleanFlag, EnumFlagOptions, Default} from './interfaces'
 import * as Parser from './parser'
 import Command from './command'
 
@@ -12,15 +12,19 @@ export function option<T>(options: {parse: OptionFlag<T>['parse']} & Partial<Opt
   return build<T>(options)()
 }
 
-const _enum = <T = string>(opts: EnumFlagOptions<T>): OptionFlag<T> => {
+export function _enum<T = string>(opts: EnumFlagOptions<T> & {multiple: true} & ({required: true} | { default: Default<T> })): OptionFlag<T[]>
+export function _enum<T = string>(opts: EnumFlagOptions<T> & {multiple: true}): OptionFlag<T[] | undefined>
+export function _enum<T = string>(opts: EnumFlagOptions<T> & ({required: true} | { default: Default<T> })): OptionFlag<T>
+export function _enum<T = string>(opts: EnumFlagOptions<T>): OptionFlag<T | undefined>
+export function _enum<T = string>(opts: EnumFlagOptions<T>): OptionFlag<T> | OptionFlag<T[]> | OptionFlag<T | undefined> | OptionFlag<T[] | undefined> {
   return build<T>({
     async parse(input) {
       if (!opts.options.includes(input)) throw new Error(`Expected --${this.name}=${input} to be one of: ${opts.options.join(', ')}`)
       return input as unknown as T
     },
     helpValue: `(${opts.options.join('|')})`,
     ...opts,
-  })() as OptionFlag<T>
+  })()
 }
 
 export {_enum as enum}

diff --git a/src/parser/flags.ts b/src/parser/flags.ts
@@ -75,7 +75,7 @@ export function directory(opts: { exists?: boolean } & Partial<OptionFlag<string
 
 export function file(opts: Partial<OptionFlag<string>> & { exists?: boolean } & {multiple: true} & ({required: true} | { default: Default<string> })): OptionFlag<string[]>
 export function file(opts: Partial<OptionFlag<string>> & { exists?: boolean } & {multiple: true}): OptionFlag<string[] | undefined>
-export function file(opts: { exists?: boolean } & Partial<OptionFlag<string>> & ({required: true} | { default: string })): OptionFlag<string>
+export function file(opts: { exists?: boolean } & Partial<OptionFlag<string>> & ({required: true} | { default: Default<string> })): OptionFlag<string>
 export function file(opts?: { exists?: boolean } & Partial<OptionFlag<string>>): OptionFlag<string | undefined>
 export function file(opts: { exists?: boolean } & Partial<OptionFlag<string>> = {}): OptionFlag<string> | OptionFlag<string[]> | OptionFlag<string | undefined> | OptionFlag<string[] | undefined> {
   return build<string>({