Options
All
  • Public
  • Public/Protected
  • All
Menu

@bndynet/cli - v1.4.0

Index

Enumerations

Classes

Variables

Functions

Object literals

Variables

Const chalk

chalk: any = require('chalk')

Const fs

fs: any = require('fs')

Const inquirer

inquirer: any = require('inquirer')

Const lib

lib: any = require('cli-progress')

Const lineLength

lineLength: 80 = 80

Const ora

ora: any = require('ora')

Const out

out: log = console.log

Const path

path: any = require('path')

Const prompt

prompt: any = inquirer.prompt

Const sh

sh: any = require('shelljs')

Functions

ask

  • ask(askQuestions: any[]): Promise<any[]>

askQuestion

  • askQuestion(question: Question): Promise<any>

beginReadFile

  • beginReadFile(filepath: string, readCallback?: undefined | function): void

  • Parameters

    • filepath: string
    • Optional readCallback: undefined | function

    Returns void

beginRun

  • beginRun(command: string, callback?: undefined | function): void

  • Parameters

    • command: string
    • Optional callback: undefined | function

    Returns void

confirm

  • confirm(question: string): Promise<boolean>

endSection

  • endSection(): void

error

  • error(text: any): void

fdIsOK

  • fdIsOK(fd: number, err: string, successCallback?: undefined | function, errorCallback?: undefined | function): void

  • Parameters

    • fd: number
    • err: string
    • Optional successCallback: undefined | function
    • Optional errorCallback: undefined | function

    Returns void

getAutoCompleteQuestion

  • getAutoCompleteQuestion(question: string, options: any[], fnGetValue?: undefined | function): Question

  • Parameters

    • question: string
    • options: any[]
    • Optional fnGetValue: undefined | function

    Returns Question

getChoicesQuestion

  • getChoicesQuestion(question: string, options: string[]): Question

  • Parameters

    • question: string
    • options: string[]

    Returns Question

getConfirmationQuestionObject

  • getConfirmationQuestionObject(question: string): Question

getInputQuestionObject

  • getInputQuestionObject(question: string): Question

getQuestionObject

  • getQuestionObject(question: string, answerType?: AnswerType, additional?: undefined | object): Question

  • Parameters

    • question: string
    • Optional answerType: AnswerType
    • Optional additional: undefined | object

    Returns Question

info

  • info(text: any): void

input

  • input(question: string): Promise<string | boolean>

  • Parameters

    • question: string

    Returns Promise<string | boolean>

log

  • log(text: any): void

print

  • print(text: any): void

Const progress

  • progress(total?: undefined | number, format?: undefined | string, payload?: any): Progress

  • Parameters

    • Optional total: undefined | number
    • Optional format: undefined | string
    • Optional payload: any

    Returns Progress

questions

  • questions(questions: any[]): Promise<any[]>

readFile

  • readFile(filepath: string, encoding?: undefined | string): string

  • Parameters

    • filepath: string
    • Optional encoding: undefined | string

    Returns string

replaceFileContent

  • replaceFileContent(filepath: string, source: string, replacement: string, callback?: undefined | function): void

  • Parameters

    • filepath: string
    • source: string
    • replacement: string
    • Optional callback: undefined | function

    Returns void

run

  • run(command: string): void

select

  • select(question: string, options: string[]): Promise<number>

  • Parameters

    • question: string
    • options: string[]

    Returns Promise<number>

startSection

  • startSection(title: any): void

styleText

  • styleText(text: any, styleFunction?: Function): string

  • Parameters

    • text: any
    • Optional styleFunction: Function

    Returns string

success

  • success(text: any): void

suggest

  • suggest(question: string, options: any[], fnOptionValue?: undefined | function): Promise<any>

  • Parameters

    • question: string
    • options: any[]
    • Optional fnOptionValue: undefined | function

    Returns Promise<any>

Const timer

toObjectIIfJsonString

  • toObjectIIfJsonString(arg: string): string | object

warn

  • warn(text: any): void

writeFile

  • writeFile(filepath: string, fileContent: string, callback?: undefined | function): void

  • Parameters

    • filepath: string
    • fileContent: string
    • Optional callback: undefined | function

    Returns void

Object literals

Const icons

icons: object

arrowRight

arrowRight: string = "➞"

error

error: string = "✘"

flag

flag: string = "⚑"

info

info: string = "ℹ"

loading

loading: string = "⧗"

ok

ok: string = "✔"

warn

warn: string = "⚠"

Const styles

styles: object

bold

  • bold(text: string | object): string

default

  • default(text: string | object): string

error

  • error(text: string | object): string

highlight

  • highlight(text: string | object): string

info

  • info(text: string | object): string

link

  • link(text: string | object): string

success

  • success(text: string | object): string

warn

  • warn(text: string | object): string

Generated by BNDY-NET