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(loaderProperties: IComponentsManagerBuilderOptions<App>, configFile: string, variableBindings: VariableBindings): Promise<App>
Returns an App object, created with the given config, that can start and stop the Solid server. Keys of the variableBindings object should be Components.js variables. E.g.: { 'urn:solid-server:default:variable:rootFilePath': '.data' }.
Parameters
- loaderProperties: IComponentsManagerBuilderOptions<App>
  
  Components.js loader properties.
- configFile: string
  
  Path to the server config file.
- variableBindings: VariableBindings
  
  Bindings of Components.js variables.
Returns Promise<App>
- Defined in src/init/AppRunner.ts:61

`Private` createApp

createApp(componentsManager: ComponentsManager<App>, variables: Record<string, unknown>): 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:182

createCli

createCli(argv?: CliArgv): 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:111

createComponentsManager

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

`Private` resolveError

resolveError(message: string, error: unknown): 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:196

`Private` resolveVariables

resolveVariables(componentsManager: ComponentsManager<CliResolver>, argv: string[]): Promise<VariableBindings>
Handles the first Components.js instantiation, where CLI settings and variable mappings are created.
Parameters
- componentsManager: ComponentsManager<CliResolver>
- argv: string[]
Returns Promise<VariableBindings>
- Defined in src/init/AppRunner.ts:164

run

run(loaderProperties: IComponentsManagerBuilderOptions<App>, configFile: string, variableBindings: VariableBindings): Promise<void>
Starts the server with a given config. This method can be used to start the server from within another JavaScript application. Keys of the variableBindings object should be Components.js variables. E.g.: { 'urn:solid-server:default:variable:rootFilePath': '.data' }.
Parameters
- loaderProperties: IComponentsManagerBuilderOptions<App>
  
  Components.js loader properties.
- configFile: string
  
  Path to the server config file.
- variableBindings: VariableBindings
  
  Parameters to pass into the VariableResolver.
Returns Promise<void>
- Defined in src/init/AppRunner.ts:43

runCli

runCli(argv?: CliArgv): 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:95

runCliSync

runCliSync(__namedParameters: { argv?: CliArgv; stderr?: WriteStream }): 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
- __namedParameters: { argv?: CliArgv; stderr?: WriteStream }
  - Optional argv?: CliArgv
  - Optional stderr?: WriteStream
Returns void
- Defined in src/init/AppRunner.ts:84

Class AppRunner

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AppRunner

Properties

Private Readonly logger

Methods

create

Parameters

loaderProperties: IComponentsManagerBuilderOptions<App>

configFile: string

variableBindings: VariableBindings

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>

createComponentsManager

Type Parameters

T

Parameters

loaderProperties: IComponentsManagerBuilderOptions<T>

configFile: string

Returns Promise<ComponentsManager<T>>

Private resolveError

Parameters

message: string

error: unknown

Returns never

Private resolveVariables

Parameters

componentsManager: ComponentsManager<CliResolver>

argv: string[]

Returns Promise<VariableBindings>

run

Parameters

loaderProperties: IComponentsManagerBuilderOptions<App>

configFile: string

variableBindings: VariableBindings

Returns Promise<void>

runCli

Parameters

Optional argv: CliArgv

Returns Promise<void>

runCliSync

Parameters

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

Optional argv?: CliArgv

Optional stderr?: WriteStream

Returns void

Settings

Member Visibility

Theme

`Private` `Readonly` logger

`Private` createApp

`Private` resolveError

`Private` resolveVariables

`Optional` argv: CliArgv

`Optional` argv?: CliArgv

`Optional` stderr?: WriteStream