Fn<TOption, TThis>: ((this, option) => void | PromiseLike<unknown>)

Type Parameters

  • TOption extends ZOption = ZOption

    A type of command line option representation expected by reader.

  • TThis = unknown

    A type of this parameter.

Type declaration

    • (this, option): void | PromiseLike<unknown>
    • Option reader function (or method) signature.

      A reader function accepts a command line option corresponding to the key the reader is registered for and tries to recognize it.

      Parameters

      • this: TThis
      • option: TOption

        Command line option to recognize.

      Returns void | PromiseLike<unknown>

      Either nothing or promise-like instance resolved when the reader finishes option processing, either recognized or not.

Generated using TypeDoc