Logo for jsDocs.io

verdaccio

  • Version 7.0.2
  • Published
  • 144 kB
  • 20 dependencies
  • MIT license

Install

npm i verdaccio
yarn add verdaccio
pnpm add verdaccio

Overview

A lightweight private npm proxy registry

Index

Functions

Functions

function initServer

initServer: (
    config: ConfigYaml,
    port: string | void,
    version: string,
    pkgName: string
) => Promise<void>;

  • Start the server on the port defined (or the port defined in the config file)

    Parameter config

    Parameter port

    Parameter version

    Parameter pkgName

function runServer

runServer: (config?: string | ConfigYaml) => Promise<any>;

  • Exposes a server factory to be instantiated programmatically.

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

    Parameter config

Package Files (2)

Dependencies (20)

Dev Dependencies (36)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/verdaccio.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/verdaccio)
  • HTML
    <a href="https://www.jsdocs.io/package/verdaccio"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>