Home Reference Source Repository

References

Function Summary

Static Public Function Summary
public	addTrailingSlash(path: string): string Adds a trailing slashes to a path.
public	clean(path: string): Promise Cleans a directory
public	createBuilder(target: string, rocBuilder: rocBuilder, resolver: string): rocBuilder Creates a builder.
public	createServer(options: rocServerOptions, beforeUserMiddlewares: Function[]): rocServer Creates a server instance.
public	getBuilder(debug: boolean, target: string, createBuilders: function \| array \| object, extensionCreateBuilders: object \| array): rocBuilder Gets the final rocBuilder object..
public	getDevPath(relativeBuildPath: string): string Returns the current dev path.
public	getDevPort(): number Returns the current dev port.
public	getPort(): number Returns the current port.
public	getResolvePath(resolvePaths: ...string): string Used on the server to find all dependecies.
public	listSettings(rocCommandObject: object) List the settings that are possible with the current extensions.
public	markdownSettings(rocCommandObject: object) List the settings that are possible with the current extensions in a markdown format.
public	middlewares(config: object): array Returns the middlewares to be used
public	removeTrailingSlash(path: string): string Removes possible trailing slashes from a path.
public	runBuild(rocCommandObject: object): Promise Build runner.
public	runDev(rocCommandObject: object) Development runner.
public	start(rocCommandObject: object) Starts a Roc application.
public	watchClient(compiler: object): Promise Client watcher.
public	watchServer(compiler: object): Promise Server watcher.

Variable Summary

Static Public Variable Summary
public	baseConfig: object: * Gives the base configuration.
public	config: object: * Exports the default `roc.config.js`.
public	configMeta: object: * Exports the `roc.config.meta.js`.
public	metaConfig: object: * Gives the meta configuration.

Typedef Summary

Static Public Typedef Summary
public	outputPath: Object Output path object.
public	rocBuilder: Object Roc builder object.
public	rocServer: Object Roc server.
public	rocServerOptions: Object Roc server options.
public	startServer(port: number): function Starts a server.