Logo for jsDocs.io

verdaccio

  • Version 6.2.0
  • Published
  • 750 kB
  • 30 dependencies
  • MIT license

Install

npm i verdaccio
yarn add verdaccio
pnpm add verdaccio

Overview

A lightweight private npm proxy registry

Index

Functions

Functions

function runServer

runServer: (
    config?: string | ConfigYaml,
    options?: { listenArg?: string }
) => 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 });

    Parameter config

function startVerdaccio

startVerdaccio: (
    config: ConfigYaml,
    cliListen: string,
    configPath: string,
    pkgVersion: string,
    pkgName: string,
    callback: Callback
) => void;

  • Trigger the server after configuration has been loaded.

    Parameter config

    Parameter cliArguments

    Parameter configPath

    Parameter pkgVersion

    Parameter pkgName

    Deprecated

    use runServer instead

Package Files (3)

Dependencies (30)

Dev Dependencies (44)

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>