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

`Private` cliToVariables

cliToVariables(componentsManager: ComponentsManager<CliResolver>, argv: CliArgv, settings?: Record<string, unknown>): Promise<VariableBindings>
Handles the first Components.js instantiation. Uses it to extract the CLI shorthand values and use those to create variable bindings.
Parameters
- componentsManager: ComponentsManager<CliResolver>
- argv: CliArgv
- Optional settings: Record<string, unknown>
Returns Promise<VariableBindings>
- Defined in src/init/AppRunner.ts:233

create

create(loaderProperties: IComponentsManagerBuilderOptions<App>, configFile: string | string[], variableBindings?: VariableBindings, shorthand?: Shorthand): 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' }.

shorthand are CLI argument names and their corresponding values. E.g.: { rootFilePath: '.data' }. Abbreviated parameter names can not be used, so { f: '.data' } would not work.

The values in variableBindings take priority over those in shorthand.
Parameters
- loaderProperties: IComponentsManagerBuilderOptions<App>
  
  Components.js loader properties.
- configFile: string | string[]
  
  Path to the server config file(s).
- Optional variableBindings: VariableBindings
  
  Bindings of Components.js variables.
- Optional shorthand: Shorthand
  
  Shorthand values that need to be resolved.
Returns Promise<App>
- Defined in src/init/AppRunner.ts:84

`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:284

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:138

`Private` createCliResolver

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

createComponentsManager

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

`Private` extractShorthand

extractShorthand(cliExtractor: CliExtractor, argv: CliArgv): 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:258

getPackageSettings

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

Returns
The settings defined in the configuration file

Returns Promise<undefined | Record<string, unknown>>
- Defined in src/init/AppRunner.ts:187

`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:312

`Private` resolveShorthand

resolveShorthand(shorthandResolver: ShorthandResolver, shorthand: 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:270

run

run(loaderProperties: IComponentsManagerBuilderOptions<App>, configFile: string | string[], variableBindings?: VariableBindings, shorthand?: Shorthand): 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' }.

shorthand are CLI argument names and their corresponding values. E.g.: { rootFilePath: '.data' }. Abbreviated parameter names can not be used, so { f: '.data' } would not work.

The values in variableBindings take priority over those in shorthand.
Parameters
- loaderProperties: IComponentsManagerBuilderOptions<App>
  
  Components.js loader properties.
- configFile: string | string[]
  
  Path to the server config file(s).
- Optional variableBindings: VariableBindings
  
  Bindings of Components.js variables.
- Optional shorthand: Shorthand
  
  Shorthand values that need to be resolved.
Returns Promise<void>
- Defined in src/init/AppRunner.ts:57

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:122

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:111

Class AppRunner

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AppRunner

Properties

Private Readonly logger

Methods

Private cliToVariables

Parameters

componentsManager: ComponentsManager<CliResolver>

argv: CliArgv

Optional settings: Record<string, unknown>

Returns Promise<VariableBindings>

create

Parameters

loaderProperties: IComponentsManagerBuilderOptions<App>

configFile: string | string[]

Optional variableBindings: VariableBindings

Optional shorthand: Shorthand

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>

configFile: string | string[]

Returns Promise<ComponentsManager<T>>

Private extractShorthand

Parameters

cliExtractor: CliExtractor

argv: CliArgv

Returns Promise<Shorthand>

getPackageSettings

Returns

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

loaderProperties: IComponentsManagerBuilderOptions<App>

configFile: string | string[]

Optional variableBindings: VariableBindings

Optional shorthand: Shorthand

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

`Private` `Readonly` logger

`Private` cliToVariables

`Optional` settings: Record<string, unknown>

`Optional` variableBindings: VariableBindings

`Optional` shorthand: Shorthand

`Private` createApp

`Private` createCliResolver

`Private` extractShorthand

`Private` resolveError

`Private` resolveShorthand

`Optional` variableBindings: VariableBindings

`Optional` shorthand: Shorthand

`Optional` argv: CliArgv

`Optional` argv?: CliArgv

`Optional` stderr?: WriteStream