Class AppRunner

A class that can be used to instantiate and start a server based on a Component.js configuration.

Hierarchy

AppRunner

Index

Constructors

constructor

new AppRunner(): AppRunner
Returns AppRunner

Properties

`Private` `Readonly` logger

logger: Logger = ...

Methods

create

create(input?): Promise<App>
Returns an App object, created with the given config, that can start and stop the Solid server.
Parameters
- input: AppRunnerInput = {}
  
  All values necessary to configure the server.
Returns Promise<App>
- Defined in src/init/AppRunner.ts:93

`Private` createApp

createApp(componentsManager, variables): Promise<App>
The second Components.js instantiation, where the App is created and started using the variable mappings.
Parameters
- componentsManager: ComponentsManager<App>
- variables: Record<string, unknown>
Returns Promise<App>
- Defined in src/init/AppRunner.ts:292

createCli

createCli(argv?): Promise<App>
Returns an App object, created by parsing the Command line arguments, that can start and stop the Solid server. Will exit the process on failure.
Parameters
- argv: CliArgv = process.argv
  
  Command line arguments.
Returns Promise<App>
- Defined in src/init/AppRunner.ts:173

`Private` createCliResolver

createCliResolver(componentsManager): Promise<CliResolver>
Instantiates the CliResolver.
Parameters
- componentsManager: ComponentsManager<CliResolver>
Returns Promise<CliResolver>
- Defined in src/init/AppRunner.ts:254

createComponentsManager

createComponentsManager<T>(loaderProperties, configs): Promise<ComponentsManager<T>>
Creates the Components Manager that will be used for instantiating.
Type Parameters
- T
Parameters
- loaderProperties: IComponentsManagerBuilderOptions<T>
- configs: string[]
Returns Promise<ComponentsManager<T>>
- Defined in src/init/AppRunner.ts:240

`Private` extractShorthand

extractShorthand(cliExtractor, argv): Promise<Shorthand>
Uses the CliExtractor to convert the CLI args to a Shorthand object.
Parameters
- cliExtractor: CliExtractor
- argv: CliArgv
Returns Promise<Shorthand>
- Defined in src/init/AppRunner.ts:266

getPackageSettings

getPackageSettings(): Promise<undefined | Record<string, unknown>>
Retrieves settings from package.json or configuration file when part of an npm project.

Returns Promise<undefined | Record<string, unknown>>
The settings defined in the configuration file
- Defined in src/init/AppRunner.ts:209

`Private` resolveError

resolveError(message, error): never
Throws a new error that provides additional information through the extra message. Also appends the stack trace to the message. This is needed for errors that are thrown before the logger is created as we can't log those the standard way.
Parameters
- message: string
- error: unknown
Returns never
- Defined in src/init/AppRunner.ts:320

`Private` resolveShorthand

resolveShorthand(shorthandResolver, shorthand): Promise<VariableBindings>
Uses the ShorthandResolver to convert Shorthand to VariableBindings .
Parameters
- shorthandResolver: ShorthandResolver
- shorthand: Shorthand
Returns Promise<VariableBindings>
- Defined in src/init/AppRunner.ts:278

run

run(input): Promise<void>
Starts the server with a given config.
Parameters
- input: AppRunnerInput
  
  All values necessary to configure the server.
Returns Promise<void>
- Defined in src/init/AppRunner.ts:83

runCli

runCli(argv?): Promise<void>
Starts the server as a command-line application.
Parameters
- Optional argv: CliArgv
  
  Command line arguments.
Returns Promise<void>
- Defined in src/init/AppRunner.ts:157

runCliSync

runCliSync(argv): void
Starts the server as a command-line application. Will exit the process on failure.

Made non-async to lower the risk of unhandled promise rejections. This is only relevant when this is used to start as a Node.js application on its own, if you use this as part of your code you probably want to use the async version.
Parameters
- argv: {
  argv?: CliArgv;
  stderr?: WriteStream;
  }
  
  Input parameters.
  - Optional argv?: CliArgv
    
    Command line arguments.
  - Optional stderr?: WriteStream
    
    Stream that should be used to output errors before the logger is enabled.
Returns void
- Defined in src/init/AppRunner.ts:144

Class AppRunner

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AppRunner

Properties

Private Readonly logger

Methods

create

Parameters

input: AppRunnerInput = {}

Returns Promise<App>

Private createApp

Parameters

componentsManager: ComponentsManager<App>

variables: Record<string, unknown>

Returns Promise<App>

createCli

Parameters

argv: CliArgv = process.argv

Returns Promise<App>

Private createCliResolver

Parameters

componentsManager: ComponentsManager<CliResolver>

Returns Promise<CliResolver>

createComponentsManager

Type Parameters

T

Parameters

loaderProperties: IComponentsManagerBuilderOptions<T>

configs: string[]

Returns Promise<ComponentsManager<T>>

Private extractShorthand

Parameters

cliExtractor: CliExtractor

argv: CliArgv

Returns Promise<Shorthand>

getPackageSettings

Returns Promise<undefined | Record<string, unknown>>

Private resolveError

Parameters

message: string

error: unknown

Returns never

Private resolveShorthand

Parameters

shorthandResolver: ShorthandResolver

shorthand: Shorthand

Returns Promise<VariableBindings>

run

Parameters

input: AppRunnerInput

Returns Promise<void>

runCli

Parameters

Optional argv: CliArgv

Returns Promise<void>

runCliSync

Parameters

argv: { argv?: CliArgv; stderr?: WriteStream; }

Optional argv?: CliArgv

Optional stderr?: WriteStream

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` logger

`Private` createApp

`Private` createCliResolver

`Private` extractShorthand

`Private` resolveError

`Private` resolveShorthand

`Optional` argv: CliArgv

argv: {
argv?: CliArgv;
stderr?: WriteStream;
}

`Optional` argv?: CliArgv

`Optional` stderr?: WriteStream