Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

ArgvProvider

ArgvProvider: function

ArgvProvider - is a function to return argv. It is () => process.argv by default.

Type declaration

    • (): string[]
    • Returns string[]

CliHelper

CliHelper: function

CliHelper - is a function that takes CLI declaration and returns data user inputed

Type declaration

    • <D>(decl: D): ResolveCliDeclaration<D>
    • Type parameters

      • D: CliDeclaration

      Parameters

      • decl: D

      Returns ResolveCliDeclaration<D>

CreateCliHelperParams

CreateCliHelperParams: object

Type declaration

Exiter

Exiter: function

Exiter - is a function that handles premature exit from program. It will be fired when user inputs invalid data or asked for help with --help flag. It is process.exit(...) by default

Type declaration

    • (hasErrors: boolean): void
    • Parameters

      • hasErrors: boolean

      Returns void

Writer

Writer: function

Writer - is a function to be called by typed-cli when it reports invalid data or printing help. For the most cases console.log works fine.

Type declaration

    • (str: string, logType: "log" | "error"): void
    • Parameters

      • str: string
      • logType: "log" | "error"

      Returns void

Functions

createCliHelper

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc