Documentation
    Preparing search index...

    Class default

    The configure command is used to configure packages after installation

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    commandName description options name verbose? force? stubsRoot app kernel

    Accessors

    parsedFlags parsedArgs staysAlive startApp

    Methods

    createCodemods run prepare? interact? completed? exec terminate

    Constructors

    Properties

    commandName: string = 'configure'

    The command name one can type to run the command

    description: string = 'Configure a package after it has been installed'

    The command description

    options: CommandOptions = ...

    Configuration options accepted by the command

    name: string

    Name of the package to configure

    verbose?: boolean

    Turn on verbose mode for packages installation

    force?: boolean

    Forcefully overwrite existing files.

    stubsRoot: string

    The root of the stubs directory. The value is defined after we import the package

    app: ApplicationService
    kernel: Kernel

    Accessors

    • get parsedFlags(): { [argName: string]: any }

      Exposing all flags from the protected property "parsed"

      Returns { [argName: string]: any }

    • get parsedArgs(): (string | number)[]

      Exposing all args from the protected property "parsed"

      Returns (string | number)[]

    • get staysAlive(): undefined | boolean

      Returns undefined | boolean

    • get startApp(): undefined | boolean

      Returns undefined | boolean

    Methods

    • Run method is invoked by ace automatically

      Returns Promise<void>

    • The prepare template method is used to prepare the state for the command. This is the first method executed on a given command instance.

      Parameters

      • ..._: any[]

      Returns any

    • The interact template method is used to display the prompts to the user. The method is called after the prepare method.

      Parameters

      • ..._: any[]

      Returns any

    • The completed method is the method invoked after the command finishes or results in an error.

      You can access the command error using the this.error property. Returning true from completed method supresses the error reporting to the kernel layer.

      Parameters

      • ..._: any[]

      Returns any

    • Terminate the app. A command should prefer calling this method over the "app.terminate", because this method only triggers app termination when the current command is in the charge of the process.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods