1 | # @verdaccio/local-storage
|
2 |
|
3 | 📦 File system storage plugin for verdaccio
|
4 |
|
5 | [![verdaccio (latest)](https://img.shields.io/npm/v/@verdaccio/local-storage/latest.svg)](https://www.npmjs.com/package/@verdaccio/local-storage)
|
6 | [![CircleCI](https://circleci.com/gh/verdaccio/local-storage/tree/master.svg?style=svg)](https://circleci.com/gh/verdaccio/local-storage/tree/master)
|
7 | [![Known Vulnerabilities](https://snyk.io/test/github/verdaccio/local-storage/badge.svg?targetFile=package.json)](https://snyk.io/test/github/verdaccio/local-storage?targetFile=package.json)
|
8 | [![codecov](https://codecov.io/gh/verdaccio/local-storage/branch/master/graph/badge.svg)](https://codecov.io/gh/verdaccio/local-storage)
|
9 | [![backers](https://opencollective.com/verdaccio/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/verdaccio)
|
10 | [![discord](https://img.shields.io/discord/388674437219745793.svg)](http://chat.verdaccio.org/)
|
11 | ![MIT](https://img.shields.io/github/license/mashape/apistatus.svg)
|
12 | [![node](https://img.shields.io/node/v/@verdaccio/local-storage/latest.svg)](https://www.npmjs.com/package/@verdaccio/local-storage)
|
13 |
|
14 | > This package is already built-in in verdaccio
|
15 |
|
16 | ```
|
17 | npm install @verdaccio/local-storage
|
18 | ```
|
19 |
|
20 | ### API
|
21 |
|
22 | ### LocalDatabase
|
23 |
|
24 | The main object that handle a JSON database the private packages.
|
25 |
|
26 | #### Constructor
|
27 |
|
28 | ```
|
29 | new LocalDatabase(config, logger);
|
30 | ```
|
31 |
|
32 | * **config**: A verdaccio configuration instance.
|
33 | * **logger**: A logger instance
|
34 |
|
35 | ### LocalFS
|
36 |
|
37 | A class that handle an package instance in the File System
|
38 |
|
39 | ```
|
40 | new LocalFS(packageStoragePath, logger);
|
41 | ```
|
42 |
|
43 |
|
44 |
|
45 | ## License
|
46 | Verdaccio is [MIT licensed](https://github.com/verdaccio/local-storage/blob/master/LICENSE).
|
47 |
|
48 |
|
49 | [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fverdaccio%2Flocal-storage.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fverdaccio%2Flocal-storage?ref=badge_large)
|