0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-01-13 22:48:31 -05:00
verdaccio/website/versioned_docs/version-6.x/api/node-api/modules.md
2023-10-10 18:54:30 +02:00

1.3 KiB

id title sidebar_label sidebar_position custom_edit_url
modules @verdaccio/node-api Exports 0.5 null

Functions

initServer

initServer(config, port, version, pkgName): Promise<void>

Start the server on the port defined

Parameters

Name Type
config ConfigYaml
port string | void
version string
pkgName string

Returns

Promise<void>

Defined in

server.ts:103


runServer

runServer(config?): Promise<any>

Exposes a server factory to be instantiated programmatically.

const app = await runServer(); // default configuration
const app = await runServer('./config/config.yaml');
const app = await runServer({ configuration });
app.listen(4000, (event) => {
// do something
});

Parameters

Name Type
config? string | ConfigYaml

Returns

Promise<any>

Defined in

server.ts:186