Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "clui/commands/commands"

Index

Type aliases

Variables

Functions

Object literals

Type aliases

CommandType

CommandType: { child?: Array<CommandType>; command: string; description: string; steps: Array<WorkflowStep | Feature>; ui?: Element | string }

Type declaration

  • Optional child?: Array<CommandType>
  • command: string
  • description: string
  • steps: Array<WorkflowStep | Feature>
  • Optional ui?: Element | string

RunnableFeature

RunnableFeature: {}

Type declaration

  • [command: string]: { description: string; run: () => Element }
    • description: string
    • run: () => Element
        • (): Element

        • Returns Element

Variables

CUSTOM_RUN

CUSTOM_RUN: { description: string; feature: Feature; name: string; noDisplay?: undefined | false | true; ui?: Element | string }

Type declaration

  • description: string
  • feature: Feature
  • name: string
  • Optional noDisplay?: undefined | false | true
  • Optional ui?: Element | string

Functions

Const customRunCommand

  • customRunCommand(): { commands: {} }

  • Returns { commands: {} }

    • commands: {}

Const generateFeatures

  • generateFeatures(): { commands: {} }

  • Generates CLUI command for all Features and passes it to custom component Uses FeatureUi to generate UI for all Features

    Returns { commands: {} }

    • commands: {}

Const generateWorkflows

  • generateWorkflows(): { child?: Array<CommandType>; command: string; description: string; steps: Array<WorkflowStep | Feature>; ui?: Element | string }[]

  • Generates the CLUI command for all workflows and passes to custom ui component Uses WorkflowUi to generate UI for workflows

    Returns { child?: Array<CommandType>; command: string; description: string; steps: Array<WorkflowStep | Feature>; ui?: Element | string }[]

Object literals

Const command

command: object

commands

commands: object

Clear

Clear: { description: string; run: any } = clear

Type declaration

  • description: string
  • run: function
    • run(): Element

    • Returns Element

Features

Features: object

description

description: string = "All Available Features"

Workflows

Workflows: object

description

description: string = "Automated Workflows"

Generated using TypeDoc