Variable FlagsConst

Type Declaration

• boolean: <T = boolean>(options?: Partial<BooleanFlag<T>>) => BooleanFlag<T>

• custom: {
      <T = string, P extends CustomOptions = CustomOptions>(
          defaults: Partial<OptionFlag<T[], P>> & (
              { multiple: true; } & ({ default: FlagDefault<T[] | undefined, P>; } | { required: true; })
          ),
      ): FlagDefinition<T, P, {}>;
      <T = string, P extends CustomOptions = CustomOptions>(
          defaults: Partial<OptionFlag<NotArray<T>, P>> & (
              { multiple?: false | undefined; } & ({ default: FlagDefault<NotArray<T> | undefined, P>; } | { required: true; })
          ),
      ): FlagDefinition<T, P, {}>;
      <T = string, P extends CustomOptions = CustomOptions>(
          defaults: Partial<OptionFlag<NotArray<T>, P>> & {},
      ): FlagDefinition<T, P, {}>;
      <T = string, P extends CustomOptions = CustomOptions>(
          defaults: Partial<OptionFlag<T[], P>> & {},
      ): FlagDefinition<T, P, {}>;
      <T = string, P extends CustomOptions = CustomOptions>(): FlagDefinition<
          T,
          P,
          {},
      >;
  }

• directory: FlagDefinition<string, {}, {}>

• duration: FlagDefinition<Duration, DurationFlagConfig, {}>

• file: FlagDefinition<string, {}, {}>

• integer: FlagDefinition<number, {}, {}>

• option: {
      <T extends readonly string[], P extends CustomOptions>(
          defaults: Partial<OptionFlag<ReadonlyElementOf<T>[], P>> & (
              { multiple: true; options: T; } & ({ default: FlagDefault<ReadonlyElementOf<T>[] | undefined, P>; } | { required: true; })
          ),
      ): FlagDefinition<((readonly string[] | undefined) & T)[number], P, {}>;
      <T extends readonly string[], P extends CustomOptions>(
          defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & (
              { multiple?: false | undefined; options: T; } & ({ default: FlagDefault<ReadonlyElementOf<T> | undefined, P>; } | { required: true; })
          ),
      ): FlagDefinition<((readonly string[] | undefined) & T)[number], P, {}>;
      <T extends readonly string[], P extends CustomOptions>(
          defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & {},
      ): FlagDefinition<((readonly string[] | undefined) & T)[number], P, {}>;
      <T extends readonly string[], P extends CustomOptions>(
          defaults: Partial<OptionFlag<ReadonlyElementOf<T>[], P>> & {},
      ): FlagDefinition<((readonly string[] | undefined) & T)[number], P, {}>;
  }

• optionalHub: FlagDefinition<Org, CustomOptions, {}>

• optionalOrg: FlagDefinition<Org, CustomOptions, {}>

• orgApiVersion: FlagDefinition<string, CustomOptions, {}>

• requiredHub: FlagDefinition<Org, CustomOptions, {}>

• requiredOrg: FlagDefinition<Org, CustomOptions, {}>

• salesforceId: FlagDefinition<string, IdFlagConfig, {}>

• string: FlagDefinition<string, CustomOptions, {}>

• url: FlagDefinition<URL, CustomOptions, {}>