iniquity

A re-imagining of the iconic BBS software.

View on GitHub

Class: Runtime

iniquity/src/commands/runtime.Runtime

Iniquity Runtime

summary The main entry into all iniquity cli commands that are available.

implements {yargs.CommandModule}

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Runtime()

Properties

command

command: string = "runtime [action]"

Implementation of

yargs.CommandModule.command

Defined in

iniquity/src/commands/runtime.ts:60


describe

describe: string = "Start your iniquity instance."

Implementation of

yargs.CommandModule.describe

Defined in

iniquity/src/commands/runtime.ts:61

Methods

builder

builder(yargs): Argv<{ up: undefined | string } & { down: undefined | string } & { restart: undefined | string }>

Parameters

Name Type
yargs Argv<Object>

Returns

Argv<{ up: undefined | string } & { down: undefined | string } & { restart: undefined | string }>

Implementation of

yargs.CommandModule.builder

Defined in

iniquity/src/commands/runtime.ts:63


handler

handler(argv): void

Parameters

Name Type
argv Object

Returns

void

Implementation of

yargs.CommandModule.handler

Defined in

iniquity/src/commands/runtime.ts:79