Skip to content

OrbitalConfiguration

Type: Interface

The OrbitalConfiguration interface has all the configurable properties for Orbital projects. Should be assigned to config property of CLI.

Properties

Property Type Description Example
helpMessage string The first message that will be displayed to CLI users. 'This is help for my CLI.'
loggerPrefix string The message that comes before logger messages 'Orbital'

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { OrbitalConfiguration } from '@orbital/core';

@Command({
    name: 'foo'
})
export class FooCommand extends Executable {
    execute() {
        console.log('foo')
    }
}