Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AppRunner

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

Hierarchy

  • AppRunner

Index

Constructors

Properties

Methods

Constructors

constructor

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>

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>

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>

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

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

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>

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>

runCli

  • runCli(argv?: CliArgv): Promise<void>

  • Starts the server as a command-line application.

    Parameters

    • Optional argv: CliArgv

      Command line arguments.

    Returns Promise<void>

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