Private
Readonly
loggerPrivate
cliHandles the first Components.js instantiation. Uses it to extract the CLI shorthand values and use those to create variable bindings.
Optional
settings: Record<string, unknown>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
.
Components.js loader properties.
Path to the server config file(s).
Optional
variableBindings: VariableBindingsBindings of Components.js variables.
Optional
shorthand: ShorthandShorthand values that need to be resolved.
Private
createPrivate
createInstantiates the CliResolver.
Creates the Components Manager that will be used for instantiating.
Private
extractUses the CliExtractor to convert the CLI args to a Shorthand object.
Private
resolveThrows 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.
Private
resolveUses the ShorthandResolver to convert Shorthand to VariableBindings .
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
.
Components.js loader properties.
Path to the server config file(s).
Optional
variableBindings: VariableBindingsBindings of Components.js variables.
Optional
shorthand: ShorthandShorthand values that need to be resolved.
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.
Optional
argv?: CliArgvOptional
stderr?: WriteStream
A class that can be used to instantiate and start a server based on a Component.js configuration.