Infrastructure/verdaccio
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00
Code Issues Activity

chore: remove versioned docs 7.x

Browse source 
not longer need it
This commit is contained in:
Juan Picado 2024-09-26 23:00:18 +02:00
parent 11ce908fc6
commit a5ae8b5f82
168 changed files with 1 additions and 17136 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
website/docusaurus.config.js
View file

@ -416,15 +416,7 @@ module.exports = {
return `https://github.com/verdaccio/verdaccio/edit/master/website/docs/${docPath}`;
},
lastVersion: '6.x',
// onlyIncludeVersions: ['next', '5.x', '6.x'],
versions: {
// current: {
// label: `next`,
// },
'7.x': {
label: `7.x`,
banner: 'unreleased',
},
'6.x': {
label: `6.x`,
},

56
website/versioned_docs/version-7.x/amazon.md
View file

@ -1,56 +0,0 @@
---
id: amazon
title: 'Amazon Web Services'
---
This document describes several approaches for deploying Verdaccio in the AWS cloud.
## EC2 {#ec2}
[CloudFormation template for deploying this stack.](https://github.com/verdaccio/verdaccio/blob/master/contrib/aws/cloudformation-ec2-efs.yaml)
Architecture:
```
Clients
|
| (HTTPS)
v
Application Load Balancer
|
| (HTTP)
v
EC2 Auto Scaling Group (Amazon Linux 2)
Docker image (Verdaccio)
|
| (NFS)
v
Elastic File System
```
Architecture notes:
- Deploy this stack into the region closest to your users for maximum performance.
- We use an auto scaling group primarily for self-healing. The system requirements of Verdaccio are pretty low, so it's unlikely you'll need multiple instances to handle traffic load.
- Because Amazon Linux 2 doesn't include Node, we run Verdaccio as a Docker image rather than natively on the instance. This is faster and more secure than relying on third party package sources for Node.
- Elastic File System is cheap and stateful, and works across AZs. An alternative would be the [third-party S3 storage plugin](https://github.com/remitly/verdaccio-s3-storage).
- For backup, use AWS Backup
Estimated monthly cost for a small installation (in us-east-1):
- ALB (1 LCU average): $22.265/mo
- EC2 (t3.nano): $3.796/mo
- EBS (8gb): $0.80/mo
- EFS (5gb): $1.5/mo
- Data transfer: (10gb): $0.9/mo
- **TOTAL:** Under $30/mo
## ECS {#ecs}
You can deploy Verdaccio as a task with an [ECS Volume](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) for persistent storage.
Note: Fargate doesn't support persistent volumes, so you have to use the S3 storage plugin.
## EKS {#eks}
See the documentation pages on [Kubernetes](kubernetes) and [Docker](docker).

20
website/versioned_docs/version-7.x/ansible.md
View file

@ -1,20 +0,0 @@
---
id: ansible
title: 'Ansible'
---
We have a customised solution for `verdaccio` in our organization.
[https://github.com/verdaccio/ansible-verdaccio](https://github.com/verdaccio/ansible-verdaccio)
#### Other options {#other-options}
- Ansible role for Gentoo users: [jirutka/ansible-role-sinopia](https://github.com/jirutka/ansible-role-sinopia).
- Ansible role for Ubuntu users: [jagregory/sinopia-ansible](https://github.com/jagregory/sinopia-ansible).
- ansible-verdaccio-role [https://github.com/refinery29/ansible-verdaccio-role](https://github.com/refinery29/ansible-verdaccio-role)
#### Related talks {#related-talks}
> Only in Spanish
<iframe width="560" height="315" src="https://www.youtube.com/embed/EWAxCgZQMAY?enablejsapi=1" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

1
website/versioned_docs/version-7.x/api/config/_category_.yml
View file

@ -1 +0,0 @@
label: '@verdaccio/config'

323
website/versioned_docs/version-7.x/api/config/classes/Config.md
View file

@ -1,323 +0,0 @@
---
id: 'Config'
title: 'Class: Config'
sidebar_label: 'Config'
sidebar_position: 0
custom_edit_url: null
---
Coordinates the application configuration
## Implements
- `Config`
## Constructors
### constructor
• **new Config**(`config`, `configOptions?`)
#### Parameters
| Name | Type | Default value |
| :------------------------------------------- | :----------------------------------------- | :------------ |
| `config` | `ConfigYaml` & { `config_path`: `string` } | `undefined` |
| `configOptions` | `Object` | `undefined` |
| `configOptions.forceEnhancedLegacySignature` | `boolean` | `true` |
#### Defined in
[config.ts:64](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L64)
## Properties
### auth
• **auth**: `any`
#### Implementation of
AppConfig.auth
#### Defined in
[config.ts:47](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L47)
---
### configOptions
• `Private` **configOptions**: `Object`
#### Type declaration
| Name | Type |
| :----------------------------- | :-------- |
| `forceEnhancedLegacySignature` | `boolean` |
#### Defined in
[config.ts:63](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L63)
---
### configPath
• **configPath**: `string`
#### Implementation of
AppConfig.configPath
#### Defined in
[config.ts:49](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L49)
---
### flags
• **flags**: `FlagsConfig`
#### Implementation of
AppConfig.flags
#### Defined in
[config.ts:61](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L61)
---
### packages
• **packages**: `PackageList`
#### Implementation of
AppConfig.packages
#### Defined in
[config.ts:45](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L45)
---
### plugins
• **plugins**: `null` \| `string` \| `void`
#### Implementation of
AppConfig.plugins
#### Defined in
[config.ts:56](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L56)
---
### secret
• **secret**: `string`
#### Implementation of
AppConfig.secret
#### Defined in
[config.ts:60](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L60)
---
### security
• **security**: `Security`
#### Implementation of
AppConfig.security
#### Defined in
[config.ts:57](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L57)
---
### self_path
• **self_path**: `string`
**`Deprecated`**
use configPath or config.getConfigPath();
#### Implementation of
AppConfig.self_path
#### Defined in
[config.ts:53](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L53)
---
### serverSettings
• **serverSettings**: `ServerSettingsConf`
#### Defined in
[config.ts:58](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L58)
---
### server_id
• **server_id**: `string`
#### Implementation of
AppConfig.server_id
#### Defined in
[config.ts:48](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L48)
---
### storage
• **storage**: `string` \| `void`
#### Implementation of
AppConfig.storage
#### Defined in
[config.ts:54](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L54)
---
### uplinks
• **uplinks**: `any`
#### Implementation of
AppConfig.uplinks
#### Defined in
[config.ts:44](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L44)
---
### userRateLimit
• **userRateLimit**: `RateLimit`
#### Implementation of
AppConfig.userRateLimit
#### Defined in
[config.ts:62](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L62)
---
### user_agent
• **user_agent**: `undefined` \| `string`
#### Implementation of
AppConfig.user_agent
#### Defined in
[config.ts:43](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L43)
---
### users
• **users**: `any`
#### Defined in
[config.ts:46](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L46)
## Methods
### checkSecretKey
▸ **checkSecretKey**(`secret?`): `string`
Store or create whether receive a secret key
**`Secret`**
external secret key
#### Parameters
| Name | Type |
| :-------- | :------- |
| `secret?` | `string` |
#### Returns
`string`
#### Implementation of
AppConfig.checkSecretKey
#### Defined in
[config.ts:150](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L150)
---
### getConfigPath
▸ **getConfigPath**(): `string`
#### Returns
`string`
#### Defined in
[config.ts:134](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L134)
---
### getMatchedPackagesSpec
▸ **getMatchedPackagesSpec**(`pkgName`): `void` \| `PackageAccess`
Check for package spec
#### Parameters
| Name | Type |
| :-------- | :------- |
| `pkgName` | `string` |
#### Returns
`void` \| `PackageAccess`
#### Implementation of
AppConfig.getMatchedPackagesSpec
#### Defined in
[config.ts:141](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L141)

206
website/versioned_docs/version-7.x/api/config/classes/ConfigBuilder.md
View file

@ -1,206 +0,0 @@
---
id: 'ConfigBuilder'
title: 'Class: ConfigBuilder'
sidebar_label: 'ConfigBuilder'
sidebar_position: 0
custom_edit_url: null
---
Helper configuration builder constructor, used to build the configuration for testing or
programatically creating a configuration.
## Constructors
### constructor
• **new ConfigBuilder**(`config?`)
#### Parameters
| Name | Type |
| :-------- | :----------------------- |
| `config?` | `Partial`<`ConfigYaml`\> |
#### Defined in
[builder.ts:21](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L21)
## Properties
### config
• `Private` **config**: `ConfigYaml`
#### Defined in
[builder.ts:19](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L19)
## Methods
### addAuth
▸ **addAuth**(`auth`): [`ConfigBuilder`](ConfigBuilder.md)
#### Parameters
| Name | Type |
| :----- | :---------------- |
| `auth` | `Partial`<`any`\> |
#### Returns
[`ConfigBuilder`](ConfigBuilder.md)
#### Defined in
[builder.ts:46](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L46)
---
### addLogger
▸ **addLogger**(`log`): [`ConfigBuilder`](ConfigBuilder.md)
#### Parameters
| Name | Type |
| :---- | :--------------- |
| `log` | `LoggerConfItem` |
#### Returns
[`ConfigBuilder`](ConfigBuilder.md)
#### Defined in
[builder.ts:51](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L51)
---
### addPackageAccess
▸ **addPackageAccess**(`pattern`, `pkgAccess`): [`ConfigBuilder`](ConfigBuilder.md)
#### Parameters
| Name | Type |
| :---------- | :------------------ |
| `pattern` | `string` |
| `pkgAccess` | `PackageAccessYaml` |
#### Returns
[`ConfigBuilder`](ConfigBuilder.md)
#### Defined in
[builder.ts:30](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L30)
---
### addSecurity
▸ **addSecurity**(`security`): [`ConfigBuilder`](ConfigBuilder.md)
#### Parameters
| Name | Type |
| :--------- | :--------------------- |
| `security` | `Partial`<`Security`\> |
#### Returns
[`ConfigBuilder`](ConfigBuilder.md)
#### Defined in
[builder.ts:41](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L41)
---
### addStorage
▸ **addStorage**(`storage`): [`ConfigBuilder`](ConfigBuilder.md)
#### Parameters
| Name | Type |
| :-------- | :------------------- |
| `storage` | `string` \| `object` |
#### Returns
[`ConfigBuilder`](ConfigBuilder.md)
#### Defined in
[builder.ts:56](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L56)
---
### addUplink
▸ **addUplink**(`id`, `uplink`): [`ConfigBuilder`](ConfigBuilder.md)
#### Parameters
| Name | Type |
| :------- | :----------- |
| `id` | `string` |
| `uplink` | `UpLinkConf` |
#### Returns
[`ConfigBuilder`](ConfigBuilder.md)
#### Defined in
[builder.ts:36](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L36)
---
### getAsYaml
▸ **getAsYaml**(): `string`
#### Returns
`string`
#### Defined in
[builder.ts:69](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L69)
---
### getConfig
▸ **getConfig**(): `ConfigYaml`
#### Returns
`ConfigYaml`
#### Defined in
[builder.ts:65](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L65)
---
### build
▸ `Static` **build**(`config?`): [`ConfigBuilder`](ConfigBuilder.md)
#### Parameters
| Name | Type |
| :-------- | :----------------------- |
| `config?` | `Partial`<`ConfigYaml`\> |
#### Returns
[`ConfigBuilder`](ConfigBuilder.md)
#### Defined in
[builder.ts:26](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/builder.ts#L26)

2
website/versioned_docs/version-7.x/api/config/classes/_category_.yml
View file

@ -1,2 +0,0 @@
label: 'Classes'
position: 3

16
website/versioned_docs/version-7.x/api/config/index.md
View file

@ -1,16 +0,0 @@
---
id: 'index'
title: '@verdaccio/config'
sidebar_label: 'Readme'
sidebar_position: 0
custom_edit_url: null
---
# @verdaccio/config
### License
Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch) files within the /assets folder) is
[Creative Commons licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE-docs).

11
website/versioned_docs/version-7.x/api/config/interfaces/LegacyPackageList.md
View file

@ -1,11 +0,0 @@
---
id: 'LegacyPackageList'
title: 'Interface: LegacyPackageList'
sidebar_label: 'LegacyPackageList'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: `PackageAccess`

2
website/versioned_docs/version-7.x/api/config/interfaces/_category_.yml
View file

@ -1,2 +0,0 @@
label: 'Interfaces'
position: 4

476
website/versioned_docs/version-7.x/api/config/modules.md
View file

@ -1,476 +0,0 @@
---
id: 'modules'
title: '@verdaccio/config'
sidebar_label: 'Exports'
sidebar_position: 0.5
custom_edit_url: null
---
## Classes
- [Config](classes/Config.md)
- [ConfigBuilder](classes/ConfigBuilder.md)
## Interfaces
- [LegacyPackageList](interfaces/LegacyPackageList.md)
## Type Aliases
### SetupDirectory
Ƭ **SetupDirectory**: `Object`
#### Type declaration
| Name | Type |
| :----- | :------- |
| `path` | `string` |
| `type` | `string` |
#### Defined in
[config-path.ts:19](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config-path.ts#L19)
## Variables
### DEFAULT_REGISTRY
• `Const` **DEFAULT_REGISTRY**: `"https://registry.npmjs.org"`
#### Defined in
[uplinks.ts:7](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/uplinks.ts#L7)
---
### DEFAULT_UPLINK
• `Const` **DEFAULT_UPLINK**: `"npmjs"`
#### Defined in
[uplinks.ts:8](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/uplinks.ts#L8)
---
### PACKAGE_ACCESS
• `Const` **PACKAGE_ACCESS**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------- |
| `ALL` | `string` |
| `SCOPE` | `string` |
#### Defined in
[package-access.ts:23](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/package-access.ts#L23)
---
### ROLES
• `Const` **ROLES**: `Object`
#### Type declaration
| Name | Type |
| :--------------------- | :------- |
| `$ALL` | `string` |
| `$ANONYMOUS` | `string` |
| `$AUTH` | `string` |
| `ALL` | `string` |
| `DEPRECATED_ALL` | `string` |
| `DEPRECATED_ANONYMOUS` | `string` |
| `DEPRECATED_AUTH` | `string` |
#### Defined in
[package-access.ts:12](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/package-access.ts#L12)
---
### TIME_EXPIRATION_1H
• `Const` **TIME_EXPIRATION_1H**: `"1h"`
#### Defined in
[security.ts:4](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/security.ts#L4)
---
### TOKEN_VALID_LENGTH
• `Const` **TOKEN_VALID_LENGTH**: `32`
#### Defined in
[token.ts:3](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/token.ts#L3)
---
### WEB_TITLE
• `Const` **WEB_TITLE**: `"Verdaccio"`
#### Defined in
[config.ts:31](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L31)
---
### defaultLoggedUserRoles
• `Const` **defaultLoggedUserRoles**: `string`[]
All logged users will have by default the group $all and $authenticate
#### Defined in
[user.ts:8](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/user.ts#L8)
---
### defaultNonLoggedUserRoles
• `Const` **defaultNonLoggedUserRoles**: `string`[]
#### Defined in
[user.ts:18](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/user.ts#L18)
---
### defaultSecurity
• `Const` **defaultSecurity**: `Security`
#### Defined in
[security.ts:18](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/security.ts#L18)
---
### defaultUserRateLimiting
• `Const` **defaultUserRateLimiting**: `Object`
#### Type declaration
| Name | Type |
| :--------- | :------- |
| `max` | `number` |
| `windowMs` | `number` |
#### Defined in
[config.ts:34](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config.ts#L34)
## Functions
### createAnonymousRemoteUser
▸ **createAnonymousRemoteUser**(): `RemoteUser`
Builds an anonymous remote user in case none is logged in.
#### Returns
`RemoteUser`
{ name: xx, groups: [], real_groups: [] }
#### Defined in
[user.ts:47](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/user.ts#L47)
---
### createRemoteUser
▸ **createRemoteUser**(`name`, `pluginGroups`): `RemoteUser`
Create a RemoteUser object
#### Parameters
| Name | Type |
| :------------- | :--------- |
| `name` | `string` |
| `pluginGroups` | `string`[] |
#### Returns
`RemoteUser`
{ name: xx, pluginGroups: [], real_groups: [] }
#### Defined in
[user.ts:30](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/user.ts#L30)
---
### findConfigFile
▸ **findConfigFile**(`configPath?`): `string`
Find and get the first config file that match.
#### Parameters
| Name | Type |
| :------------ | :------- |
| `configPath?` | `string` |
#### Returns
`string`
the config file path
#### Defined in
[config-path.ts:30](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config-path.ts#L30)
---
### fromJStoYAML
▸ **fromJStoYAML**(`config`): `string` \| `null`
#### Parameters
| Name | Type |
| :------- | :----------------------- |
| `config` | `Partial`<`ConfigYaml`\> |
#### Returns
`string` \| `null`
#### Defined in
[parse.ts:56](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/parse.ts#L56)
---
### generateRandomSecretKey
▸ **generateRandomSecretKey**(): `string`
Secret key must have 32 characters.
#### Returns
`string`
#### Defined in
[token.ts:8](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/token.ts#L8)
---
### getDefaultConfig
▸ **getDefaultConfig**(`fileName?`): `ConfigYaml` & { `configPath`: `string` ; `config_path`: `string` }
#### Parameters
| Name | Type | Default value |
| :--------- | :------- | :--------------- |
| `fileName` | `string` | `'default.yaml'` |
#### Returns
`ConfigYaml` & { `configPath`: `string` ; `config_path`: `string` }
#### Defined in
[conf/index.ts:5](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/conf/index.ts#L5)
---
### getUserAgent
▸ **getUserAgent**(`customUserAgent?`, `version?`, `name?`): `string`
#### Parameters
| Name | Type |
| :----------------- | :-------------------- |
| `customUserAgent?` | `string` \| `boolean` |
| `version?` | `string` |
| `name?` | `string` |
#### Returns
`string`
#### Defined in
[agent.ts:3](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/agent.ts#L3)
---
### hasProxyTo
▸ **hasProxyTo**(`pkg`, `upLink`, `packages`): `boolean`
#### Parameters
| Name | Type |
| :--------- | :------------ |
| `pkg` | `string` |
| `upLink` | `string` |
| `packages` | `PackageList` |
#### Returns
`boolean`
#### Defined in
[uplinks.ts:51](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/uplinks.ts#L51)
---
### normalisePackageAccess
▸ **normalisePackageAccess**(`packages`): [`LegacyPackageList`](interfaces/LegacyPackageList.md)
#### Parameters
| Name | Type |
| :--------- | :----------------------------------------------------- |
| `packages` | [`LegacyPackageList`](interfaces/LegacyPackageList.md) |
#### Returns
[`LegacyPackageList`](interfaces/LegacyPackageList.md)
#### Defined in
[package-access.ts:50](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/package-access.ts#L50)
---
### normalizeUserList
▸ **normalizeUserList**(`groupsList`): `any`
#### Parameters
| Name | Type |
| :----------- | :---- |
| `groupsList` | `any` |
#### Returns
`any`
#### Defined in
[package-access.ts:28](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/package-access.ts#L28)
---
### parseConfigFile
▸ **parseConfigFile**(`configPath`): `ConfigYaml` & { `configPath`: `string` ; `config_path`: `string` }
Parse a config file from yaml to JSON.
#### Parameters
| Name | Type | Description |
| :----------- | :------- | :------------------------------------------ |
| `configPath` | `string` | the absolute path of the configuration file |
#### Returns
`ConfigYaml` & { `configPath`: `string` ; `config_path`: `string` }
#### Defined in
[parse.ts:17](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/parse.ts#L17)
---
### readDefaultConfig
▸ **readDefaultConfig**(): `Buffer`
#### Returns
`Buffer`
#### Defined in
[config-path.ts:66](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/config-path.ts#L66)
---
### sanityCheckNames
▸ **sanityCheckNames**(`item`, `users`): `any`
#### Parameters
| Name | Type |
| :------ | :------- |
| `item` | `string` |
| `users` | `any` |
#### Returns
`any`
#### Defined in
[uplinks.ts:61](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/uplinks.ts#L61)
---
### sanityCheckUplinksProps
▸ **sanityCheckUplinksProps**(`configUpLinks`): `UpLinksConfList`
#### Parameters
| Name | Type |
| :-------------- | :---------------- |
| `configUpLinks` | `UpLinksConfList` |
#### Returns
`UpLinksConfList`
#### Defined in
[uplinks.ts:37](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/uplinks.ts#L37)
---
### uplinkSanityCheck
▸ **uplinkSanityCheck**(`uplinks`, `users?`): `UpLinksConfList`
#### Parameters
| Name | Type | Default value |
| :-------- | :---------------- | :------------ |
| `uplinks` | `UpLinksConfList` | `undefined` |
| `users` | `any` | `BLACKLIST` |
#### Returns
`UpLinksConfList`
#### Defined in
[uplinks.ts:18](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/config/src/uplinks.ts#L18)

1
website/versioned_docs/version-7.x/api/core/_category_.yml
View file

@ -1 +0,0 @@
label: '@verdaccio/core'

2
website/versioned_docs/version-7.x/api/core/classes/_category_.yml
View file

@ -1,2 +0,0 @@
label: 'Classes'
position: 3

106
website/versioned_docs/version-7.x/api/core/classes/pluginUtils.Plugin.md
View file

@ -1,106 +0,0 @@
---
id: 'pluginUtils.Plugin'
title: 'Class: Plugin<PluginConfig>'
sidebar_label: 'pluginUtils.Plugin'
custom_edit_url: null
---
[pluginUtils](../namespaces/pluginUtils.md).Plugin
The base plugin class, set of utilities for developing
plugins.
## Type parameters
| Name |
| :------------- |
| `PluginConfig` |
## Hierarchy
- **`Plugin`**
↳ [`Storage`](../interfaces/pluginUtils.Storage.md)
↳ [`ExpressMiddleware`](../interfaces/pluginUtils.ExpressMiddleware.md)
↳ [`Auth`](../interfaces/pluginUtils.Auth.md)
↳ [`ManifestFilter`](../interfaces/pluginUtils.ManifestFilter.md)
## Constructors
### constructor
• **new Plugin**<`PluginConfig`\>(`config`, `options`)
#### Type parameters
| Name |
| :------------- |
| `PluginConfig` |
#### Parameters
| Name | Type |
| :-------- | :------------------------------------------------------------ |
| `config` | `PluginConfig` |
| `options` | [`PluginOptions`](../interfaces/pluginUtils.PluginOptions.md) |
#### Defined in
[plugin-utils.ts:38](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L38)
## Properties
### config
• `Readonly` **config**: `unknown`
#### Defined in
[plugin-utils.ts:36](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L36)
---
### options
• `Readonly` **options**: [`PluginOptions`](../interfaces/pluginUtils.PluginOptions.md)
#### Defined in
[plugin-utils.ts:37](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L37)
---
### version
• `Readonly` **version**: `number`
#### Defined in
[plugin-utils.ts:35](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L35)
---
### version
▪ `Static` **version**: `number` = `1`
#### Defined in
[plugin-utils.ts:34](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L34)
## Methods
### getVersion
▸ **getVersion**(): `number`
#### Returns
`number`
#### Defined in
[plugin-utils.ts:44](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L44)

47
website/versioned_docs/version-7.x/api/core/enums/HtpasswdHashAlgorithm.md
View file

@ -1,47 +0,0 @@
---
id: 'HtpasswdHashAlgorithm'
title: 'Enumeration: HtpasswdHashAlgorithm'
sidebar_label: 'HtpasswdHashAlgorithm'
sidebar_position: 0
custom_edit_url: null
---
## Enumeration Members
### bcrypt
• **bcrypt** = `"bcrypt"`
#### Defined in
[constants.ts:119](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L119)
---
### crypt
• **crypt** = `"crypt"`
#### Defined in
[constants.ts:118](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L118)
---
### md5
• **md5** = `"md5"`
#### Defined in
[constants.ts:116](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L116)
---
### sha1
• **sha1** = `"sha1"`
#### Defined in
[constants.ts:117](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L117)

2
website/versioned_docs/version-7.x/api/core/enums/_category_.yml
View file

@ -1,2 +0,0 @@
label: 'Enumerations'
position: 2

68
website/versioned_docs/version-7.x/api/core/enums/warningUtils.Codes.md
View file

@ -1,68 +0,0 @@
---
id: 'warningUtils.Codes'
title: 'Enumeration: Codes'
sidebar_label: 'warningUtils.Codes'
custom_edit_url: null
---
[warningUtils](../namespaces/warningUtils.md).Codes
## Enumeration Members
### VERDEP003
• **VERDEP003** = `"VERDEP003"`
#### Defined in
[warning-utils.ts:14](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/warning-utils.ts#L14)
---
### VERWAR001
• **VERWAR001** = `"VERWAR001"`
#### Defined in
[warning-utils.ts:8](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/warning-utils.ts#L8)
---
### VERWAR002
• **VERWAR002** = `"VERWAR002"`
#### Defined in
[warning-utils.ts:9](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/warning-utils.ts#L9)
---
### VERWAR003
• **VERWAR003** = `"VERWAR003"`
#### Defined in
[warning-utils.ts:10](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/warning-utils.ts#L10)
---
### VERWAR004
• **VERWAR004** = `"VERWAR004"`
#### Defined in
[warning-utils.ts:11](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/warning-utils.ts#L11)
---
### VERWAR005
• **VERWAR005** = `"VERWAR005"`
#### Defined in
[warning-utils.ts:12](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/warning-utils.ts#L12)

27
website/versioned_docs/version-7.x/api/core/index.md
View file

@ -1,27 +0,0 @@
---
id: 'index'
title: '@verdaccio/core'
sidebar_label: 'Readme'
sidebar_position: 0
custom_edit_url: null
---
# Core
[![CircleCI](https://circleci.com/gh/verdaccio/streams.svg?style=svg)](https://circleci.com/gh/ayusharma/@verdaccio/streams)
[![codecov](https://codecov.io/gh/verdaccio/streams/branch/master/graph/badge.svg)](https://codecov.io/gh/verdaccio/streams)
[![verdaccio (latest)](https://img.shields.io/npm/v/@verdaccio/streams/latest.svg)](https://www.npmjs.com/package/@verdaccio/streams)
[![backers](https://opencollective.com/verdaccio/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/verdaccio)
[![discord](https://img.shields.io/discord/388674437219745793.svg)](http://chat.verdaccio.org/)
![MIT](https://img.shields.io/github/license/mashape/apistatus.svg)
[![node](https://img.shields.io/node/v/@verdaccio/streams/latest.svg)](https://www.npmjs.com/package/@verdaccio/streams)
This project provides an extension of `PassThrough` stream.
## Detail
It provides 2 additional methods `abort()` and `done()`. Those implementations are widely use in the verdaccio core for handle `tarballs`.
## License
MIT (http://www.opensource.org/licenses/mit-license.php)

2
website/versioned_docs/version-7.x/api/core/interfaces/_category_.yml
View file

@ -1,2 +0,0 @@
label: 'Interfaces'
position: 4

316
website/versioned_docs/version-7.x/api/core/interfaces/pluginUtils.Auth.md
View file

@ -1,316 +0,0 @@
---
id: 'pluginUtils.Auth'
title: 'Interface: Auth<T>'
sidebar_label: 'pluginUtils.Auth'
custom_edit_url: null
---
[pluginUtils](../namespaces/pluginUtils.md).Auth
The base plugin class, set of utilities for developing
plugins.
## Type parameters
| Name |
| :--- |
| `T` |
## Hierarchy
- [`Plugin`](../classes/pluginUtils.Plugin.md)<`T`\>
↳ **`Auth`**
## Properties
### config
• `Readonly` **config**: `unknown`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[config](../classes/pluginUtils.Plugin.md#config)
#### Defined in
[plugin-utils.ts:36](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L36)
---
### options
• `Readonly` **options**: [`PluginOptions`](pluginUtils.PluginOptions.md)
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[options](../classes/pluginUtils.Plugin.md#options)
#### Defined in
[plugin-utils.ts:37](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L37)
---
### version
• `Readonly` **version**: `number`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[version](../classes/pluginUtils.Plugin.md#version)
#### Defined in
[plugin-utils.ts:35](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L35)
## Methods
### adduser
▸ `Optional` **adduser**(`user`, `password`, `cb`): `void`
Handles the authenticated method.
```ts
class Auth {
public adduser(user: string, password: string, done: AuthCallback): void {
if (!password) {
return done(errorUtils.getUnauthorized(API_ERROR.BAD_USERNAME_PASSWORD));
}
// return boolean
return done(null, true);
}
```
#### Parameters
| Name | Type |
| :--------- | :------------------------------------------------------------------ |
| `user` | `string` |
| `password` | `string` |
| `cb` | [`AuthUserCallback`](../namespaces/pluginUtils.md#authusercallback) |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:144](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L144)
---
### allow_access
▸ `Optional` **allow_access**(`user`, `pkg`, `cb`): `void`
#### Parameters
| Name | Type |
| :----- | :-------------------------------------------------------------- |
| `user` | `RemoteUser` |
| `pkg` | `T` & `PackageAccess` |
| `cb` | [`AccessCallback`](../namespaces/pluginUtils.md#accesscallback) |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:153](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L153)
▸ `Optional` **allow_access**(`user`, `pkg`, `cb`): `void`
#### Parameters
| Name | Type |
| :----- | :-------------------------------------------------------------- |
| `user` | `RemoteUser` |
| `pkg` | `AllowAccess` & `PackageAccess` |
| `cb` | [`AccessCallback`](../namespaces/pluginUtils.md#accesscallback) |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:154](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L154)
---
### allow_publish
▸ `Optional` **allow_publish**(`user`, `pkg`, `cb`): `void`
#### Parameters
| Name | Type |
| :----- | :---------------------------------------------------------------------- |
| `user` | `RemoteUser` |
| `pkg` | `T` & `PackageAccess` |
| `cb` | [`AuthAccessCallback`](../namespaces/pluginUtils.md#authaccesscallback) |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:151](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L151)
▸ `Optional` **allow_publish**(`user`, `pkg`, `cb`): `void`
#### Parameters
| Name | Type |
| :----- | :---------------------------------------------------------------------- |
| `user` | `RemoteUser` |
| `pkg` | `AllowAccess` & `PackageAccess` |
| `cb` | [`AuthAccessCallback`](../namespaces/pluginUtils.md#authaccesscallback) |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:152](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L152)
---
### allow_unpublish
▸ `Optional` **allow_unpublish**(`user`, `pkg`, `cb`): `void`
#### Parameters
| Name | Type |
| :----- | :---------------------------------------------------------------------- |
| `user` | `RemoteUser` |
| `pkg` | `T` & `PackageAccess` |
| `cb` | [`AuthAccessCallback`](../namespaces/pluginUtils.md#authaccesscallback) |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:155](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L155)
▸ `Optional` **allow_unpublish**(`user`, `pkg`, `cb`): `void`
#### Parameters
| Name | Type |
| :----- | :---------------------------------------------------------------------- |
| `user` | `RemoteUser` |
| `pkg` | `AllowAccess` & `PackageAccess` |
| `cb` | [`AuthAccessCallback`](../namespaces/pluginUtils.md#authaccesscallback) |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:156](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L156)
---
### apiJWTmiddleware
▸ `Optional` **apiJWTmiddleware**(`helpers`): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>
#### Parameters
| Name | Type |
| :-------- | :---- |
| `helpers` | `any` |
#### Returns
`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>
#### Defined in
[plugin-utils.ts:161](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L161)
---
### authenticate
▸ **authenticate**(`user`, `password`, `cb`): `void`
Handles the authenticated method.
```ts
class Auth {
public authenticate(user: string, password: string, done: AuthCallback): void {
if (!password) {
return done(errorUtils.getUnauthorized(API_ERROR.BAD_USERNAME_PASSWORD));
}
// always return an array of users
return done(null, [user]);
}
```
#### Parameters
| Name | Type |
| :--------- | :---------------------------------------------------------- |
| `user` | `string` |
| `password` | `string` |
| `cb` | [`AuthCallback`](../namespaces/pluginUtils.md#authcallback) |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:130](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L130)
---
### changePassword
▸ `Optional` **changePassword**(`user`, `password`, `newPassword`, `cb`): `void`
#### Parameters
| Name | Type |
| :------------ | :-------------------------------------------------------------------------------------- |
| `user` | `string` |
| `password` | `string` |
| `newPassword` | `string` |
| `cb` | [`AuthChangePasswordCallback`](../namespaces/pluginUtils.md#authchangepasswordcallback) |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:145](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L145)
---
### getVersion
▸ **getVersion**(): `number`
#### Returns
`number`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[getVersion](../classes/pluginUtils.Plugin.md#getversion)
#### Defined in
[plugin-utils.ts:44](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L44)

38
website/versioned_docs/version-7.x/api/core/interfaces/pluginUtils.AuthPluginPackage.md
View file

@ -1,38 +0,0 @@
---
id: 'pluginUtils.AuthPluginPackage'
title: 'Interface: AuthPluginPackage'
sidebar_label: 'pluginUtils.AuthPluginPackage'
custom_edit_url: null
---
[pluginUtils](../namespaces/pluginUtils.md).AuthPluginPackage
## Properties
### packageName
• **packageName**: `string`
#### Defined in
[plugin-utils.ts:19](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L19)
---
### packageVersion
• `Optional` **packageVersion**: `string`
#### Defined in
[plugin-utils.ts:20](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L20)
---
### tag
• `Optional` **tag**: `string`
#### Defined in
[plugin-utils.ts:21](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L21)

124
website/versioned_docs/version-7.x/api/core/interfaces/pluginUtils.ExpressMiddleware.md
View file

@ -1,124 +0,0 @@
---
id: 'pluginUtils.ExpressMiddleware'
title: 'Interface: ExpressMiddleware<PluginConfig, Storage, Auth>'
sidebar_label: 'pluginUtils.ExpressMiddleware'
custom_edit_url: null
---
[pluginUtils](../namespaces/pluginUtils.md).ExpressMiddleware
This function allow add additional middleware to the application.
```ts
import express, { Request, Response } from 'express';
class Middleware extends Plugin {
// instances of auth and storage are injected
register_middlewares(app, auth, storage) {
const router = express.Router();
router.post('/my-endpoint', (req: Request, res: Response): void => {
res.status(200).end();
});
}
}
const [plugin] = await asyncLoadPlugin(...);
plugin.register_middlewares(app, auth, storage);
```
## Type parameters
| Name |
| :------------- |
| `PluginConfig` |
| `Storage` |
| `Auth` |
## Hierarchy
- [`Plugin`](../classes/pluginUtils.Plugin.md)<`PluginConfig`\>
↳ **`ExpressMiddleware`**
## Properties
### config
• `Readonly` **config**: `unknown`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[config](../classes/pluginUtils.Plugin.md#config)
#### Defined in
[plugin-utils.ts:36](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L36)
---
### options
• `Readonly` **options**: [`PluginOptions`](pluginUtils.PluginOptions.md)
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[options](../classes/pluginUtils.Plugin.md#options)
#### Defined in
[plugin-utils.ts:37](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L37)
---
### version
• `Readonly` **version**: `number`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[version](../classes/pluginUtils.Plugin.md#version)
#### Defined in
[plugin-utils.ts:35](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L35)
## Methods
### getVersion
▸ **getVersion**(): `number`
#### Returns
`number`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[getVersion](../classes/pluginUtils.Plugin.md#getversion)
#### Defined in
[plugin-utils.ts:44](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L44)
---
### register_middlewares
▸ **register_middlewares**(`app`, `auth`, `storage`): `void`
#### Parameters
| Name | Type |
| :-------- | :-------- |
| `app` | `Express` |
| `auth` | `Auth` |
| `storage` | `Storage` |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:104](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L104)

117
website/versioned_docs/version-7.x/api/core/interfaces/pluginUtils.IBasicAuth.md
View file

@ -1,117 +0,0 @@
---
id: 'pluginUtils.IBasicAuth'
title: 'Interface: IBasicAuth'
sidebar_label: 'pluginUtils.IBasicAuth'
custom_edit_url: null
---
[pluginUtils](../namespaces/pluginUtils.md).IBasicAuth
## Methods
### add_user
▸ **add_user**(`user`, `password`, `cb`): `any`
#### Parameters
| Name | Type |
| :--------- | :--------- |
| `user` | `string` |
| `password` | `string` |
| `cb` | `Function` |
#### Returns
`any`
#### Defined in
[plugin-utils.ts:169](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L169)
---
### allow_access
▸ **allow_access**(`pkg`, `user`, `callback`): `void`
#### Parameters
| Name | Type |
| :--------- | :------------------------------------------------------ |
| `pkg` | [`AuthPluginPackage`](pluginUtils.AuthPluginPackage.md) |
| `user` | `RemoteUser` |
| `callback` | `Function` |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:168](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L168)
---
### authenticate
▸ **authenticate**(`user`, `password`, `cb`): `void`
#### Parameters
| Name | Type |
| :--------- | :--------- |
| `user` | `string` |
| `password` | `string` |
| `cb` | `Function` |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:165](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L165)
---
### changePassword
▸ **changePassword**(`user`, `password`, `newPassword`, `cb`): `void`
#### Parameters
| Name | Type |
| :------------ | :--------- |
| `user` | `string` |
| `password` | `string` |
| `newPassword` | `string` |
| `cb` | `Function` |
#### Returns
`void`
#### Defined in
[plugin-utils.ts:167](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L167)
---
### invalidateToken
▸ `Optional` **invalidateToken**(`token`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------- |
| `token` | `string` |
#### Returns
`Promise`<`void`\>
#### Defined in
[plugin-utils.ts:166](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L166)

103
website/versioned_docs/version-7.x/api/core/interfaces/pluginUtils.ManifestFilter.md
View file

@ -1,103 +0,0 @@
---
id: 'pluginUtils.ManifestFilter'
title: 'Interface: ManifestFilter<T>'
sidebar_label: 'pluginUtils.ManifestFilter'
custom_edit_url: null
---
[pluginUtils](../namespaces/pluginUtils.md).ManifestFilter
The base plugin class, set of utilities for developing
plugins.
## Type parameters
| Name |
| :--- |
| `T` |
## Hierarchy
- [`Plugin`](../classes/pluginUtils.Plugin.md)<`T`\>
↳ **`ManifestFilter`**
## Properties
### config
• `Readonly` **config**: `unknown`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[config](../classes/pluginUtils.Plugin.md#config)
#### Defined in
[plugin-utils.ts:36](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L36)
---
### options
• `Readonly` **options**: [`PluginOptions`](pluginUtils.PluginOptions.md)
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[options](../classes/pluginUtils.Plugin.md#options)
#### Defined in
[plugin-utils.ts:37](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L37)
---
### version
• `Readonly` **version**: `number`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[version](../classes/pluginUtils.Plugin.md#version)
#### Defined in
[plugin-utils.ts:35](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L35)
## Methods
### filter_metadata
▸ **filter_metadata**(`packageInfo`): `Promise`<`Manifest`\>
#### Parameters
| Name | Type |
| :------------ | :--------- |
| `packageInfo` | `Manifest` |
#### Returns
`Promise`<`Manifest`\>
#### Defined in
[plugin-utils.ts:173](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L173)
---
### getVersion
▸ **getVersion**(): `number`
#### Returns
`number`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[getVersion](../classes/pluginUtils.Plugin.md#getversion)
#### Defined in
[plugin-utils.ts:44](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L44)

28
website/versioned_docs/version-7.x/api/core/interfaces/pluginUtils.PluginOptions.md
View file

@ -1,28 +0,0 @@
---
id: 'pluginUtils.PluginOptions'
title: 'Interface: PluginOptions'
sidebar_label: 'pluginUtils.PluginOptions'
custom_edit_url: null
---
[pluginUtils](../namespaces/pluginUtils.md).PluginOptions
## Properties
### config
• **config**: `Config`
#### Defined in
[plugin-utils.ts:24](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L24)
---
### logger
• **logger**: `Logger`
#### Defined in
[plugin-utils.ts:25](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L25)

286
website/versioned_docs/version-7.x/api/core/interfaces/pluginUtils.Storage.md
View file

@ -1,286 +0,0 @@
---
id: 'pluginUtils.Storage'
title: 'Interface: Storage<PluginConfig>'
sidebar_label: 'pluginUtils.Storage'
custom_edit_url: null
---
[pluginUtils](../namespaces/pluginUtils.md).Storage
The base plugin class, set of utilities for developing
plugins.
## Type parameters
| Name |
| :------------- |
| `PluginConfig` |
## Hierarchy
- [`Plugin`](../classes/pluginUtils.Plugin.md)<`PluginConfig`\>
↳ **`Storage`**
## Properties
### config
• `Readonly` **config**: `unknown`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[config](../classes/pluginUtils.Plugin.md#config)
#### Defined in
[plugin-utils.ts:36](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L36)
---
### options
• `Readonly` **options**: [`PluginOptions`](pluginUtils.PluginOptions.md)
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[options](../classes/pluginUtils.Plugin.md#options)
#### Defined in
[plugin-utils.ts:37](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L37)
---
### version
• `Readonly` **version**: `number`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[version](../classes/pluginUtils.Plugin.md#version)
#### Defined in
[plugin-utils.ts:35](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L35)
## Methods
### add
▸ **add**(`name`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :----- | :------- |
| `name` | `string` |
#### Returns
`Promise`<`void`\>
#### Defined in
[plugin-utils.ts:69](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L69)
---
### deleteToken
▸ **deleteToken**(`user`, `tokenKey`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :--------- | :------- |
| `user` | `string` |
| `tokenKey` | `string` |
#### Returns
`Promise`<`any`\>
#### Defined in
[plugin-utils.ts:78](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L78)
---
### get
▸ **get**(): `Promise`<`any`\>
#### Returns
`Promise`<`any`\>
#### Defined in
[plugin-utils.ts:71](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L71)
---
### getPackageStorage
▸ **getPackageStorage**(`packageInfo`): [`StorageHandler`](pluginUtils.StorageHandler.md)
#### Parameters
| Name | Type |
| :------------ | :------- |
| `packageInfo` | `string` |
#### Returns
[`StorageHandler`](pluginUtils.StorageHandler.md)
#### Defined in
[plugin-utils.ts:75](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L75)
---
### getSecret
▸ **getSecret**(): `Promise`<`string`\>
#### Returns
`Promise`<`string`\>
#### Defined in
[plugin-utils.ts:73](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L73)
---
### getVersion
▸ **getVersion**(): `number`
#### Returns
`number`
#### Inherited from
[Plugin](../classes/pluginUtils.Plugin.md).[getVersion](../classes/pluginUtils.Plugin.md#getversion)
#### Defined in
[plugin-utils.ts:44](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L44)
---
### init
▸ **init**(): `Promise`<`void`\>
#### Returns
`Promise`<`void`\>
#### Defined in
[plugin-utils.ts:72](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L72)
---
### readTokens
▸ **readTokens**(`filter`): `Promise`<`Token`[]\>
#### Parameters
| Name | Type |
| :------- | :------------ |
| `filter` | `TokenFilter` |
#### Returns
`Promise`<`Token`[]\>
#### Defined in
[plugin-utils.ts:79](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L79)
---
### remove
▸ **remove**(`name`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :----- | :------- |
| `name` | `string` |
#### Returns
`Promise`<`void`\>
#### Defined in
[plugin-utils.ts:70](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L70)
---
### saveToken
▸ **saveToken**(`token`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `token` | `Token` |
#### Returns
`Promise`<`any`\>
#### Defined in
[plugin-utils.ts:77](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L77)
---
### search
▸ **search**(`query`): `Promise`<[`SearchItem`](searchUtils.SearchItem.md)[]\>
#### Parameters
| Name | Type |
| :------ | :-------------------------------------------------------- |
| `query` | [`SearchQuery`](../namespaces/searchUtils.md#searchquery) |
#### Returns
`Promise`<[`SearchItem`](searchUtils.SearchItem.md)[]\>
#### Defined in
[plugin-utils.ts:76](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L76)
---
### setSecret
▸ **setSecret**(`secret`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------- | :------- |
| `secret` | `string` |
#### Returns
`Promise`<`any`\>
#### Defined in
[plugin-utils.ts:74](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L74)

213
website/versioned_docs/version-7.x/api/core/interfaces/pluginUtils.StorageHandler.md
View file

@ -1,213 +0,0 @@
---
id: 'pluginUtils.StorageHandler'
title: 'Interface: StorageHandler'
sidebar_label: 'pluginUtils.StorageHandler'
custom_edit_url: null
---
[pluginUtils](../namespaces/pluginUtils.md).StorageHandler
## Properties
### logger
• **logger**: `Logger`
#### Defined in
[plugin-utils.ts:49](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L49)
## Methods
### createPackage
▸ **createPackage**(`name`, `manifest`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :--------- | :--------- |
| `name` | `string` |
| `manifest` | `Manifest` |
#### Returns
`Promise`<`void`\>
#### Defined in
[plugin-utils.ts:60](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L60)
---
### deletePackage
▸ **deletePackage**(`fileName`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :--------- | :------- |
| `fileName` | `string` |
#### Returns
`Promise`<`void`\>
#### Defined in
[plugin-utils.ts:50](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L50)
---
### hasPackage
▸ **hasPackage**(): `Promise`<`boolean`\>
#### Returns
`Promise`<`boolean`\>
#### Defined in
[plugin-utils.ts:65](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L65)
---
### hasTarball
▸ **hasTarball**(`fileName`): `Promise`<`boolean`\>
#### Parameters
| Name | Type |
| :--------- | :------- |
| `fileName` | `string` |
#### Returns
`Promise`<`boolean`\>
#### Defined in
[plugin-utils.ts:63](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L63)
---
### readPackage
▸ **readPackage**(`name`): `Promise`<`Manifest`\>
#### Parameters
| Name | Type |
| :----- | :------- |
| `name` | `string` |
#### Returns
`Promise`<`Manifest`\>
#### Defined in
[plugin-utils.ts:57](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L57)
---
### readTarball
▸ **readTarball**(`pkgName`, `«destructured»`): `Promise`<`Readable`\>
#### Parameters
| Name | Type |
| :--------------- | :------------ |
| `pkgName` | `string` |
| `«destructured»` | `Object` |
| › `signal` | `AbortSignal` |
#### Returns
`Promise`<`Readable`\>
#### Defined in
[plugin-utils.ts:59](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L59)
---
### removePackage
▸ **removePackage**(): `Promise`<`void`\>
#### Returns
`Promise`<`void`\>
#### Defined in
[plugin-utils.ts:51](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L51)
---
### savePackage
▸ **savePackage**(`pkgName`, `value`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :-------- | :--------- |
| `pkgName` | `string` |
| `value` | `Manifest` |
#### Returns
`Promise`<`void`\>
#### Defined in
[plugin-utils.ts:58](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L58)
---
### updatePackage
▸ **updatePackage**(`packageName`, `handleUpdate`): `Promise`<`Manifest`\>
#### Parameters
| Name | Type |
| :------------- | :------------------------------------------------- |
| `packageName` | `string` |
| `handleUpdate` | (`manifest`: `Manifest`) => `Promise`<`Manifest`\> |
#### Returns
`Promise`<`Manifest`\>
#### Defined in
[plugin-utils.ts:53](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L53)
---
### writeTarball
▸ **writeTarball**(`tarballName`, `«destructured»`): `Promise`<`Writable`\>
#### Parameters
| Name | Type |
| :--------------- | :------------ |
| `tarballName` | `string` |
| `«destructured»` | `Object` |
| › `signal` | `AbortSignal` |
#### Returns
`Promise`<`Writable`\>
#### Defined in
[plugin-utils.ts:61](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L61)

84
website/versioned_docs/version-7.x/api/core/interfaces/searchUtils.SearchItem.md
View file

@ -1,84 +0,0 @@
---
id: 'searchUtils.SearchItem'
title: 'Interface: SearchItem'
sidebar_label: 'searchUtils.SearchItem'
custom_edit_url: null
---
[searchUtils](../namespaces/searchUtils.md).SearchItem
## Hierarchy
- [`UnStable`](../namespaces/searchUtils.md#unstable)
- `PrivatePackage`
↳ **`SearchItem`**
## Properties
### flags
• `Optional` **flags**: `Object`
#### Type declaration
| Name | Type |
| :---------- | :-------- |
| `unstable?` | `boolean` |
#### Inherited from
UnStable.flags
#### Defined in
[search-utils.ts:7](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L7)
---
### package
• **package**: [`SearchItemPkg`](../namespaces/searchUtils.md#searchitempkg)
#### Defined in
[search-utils.ts:29](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L29)
---
### score
• **score**: [`Score`](../namespaces/searchUtils.md#score)
#### Defined in
[search-utils.ts:30](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L30)
---
### verdaccioPkgCached
• `Optional` **verdaccioPkgCached**: `boolean`
#### Inherited from
PrivatePackage.verdaccioPkgCached
#### Defined in
[search-utils.ts:25](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L25)
---
### verdaccioPrivate
• `Optional` **verdaccioPrivate**: `boolean`
#### Inherited from
PrivatePackage.verdaccioPrivate
#### Defined in
[search-utils.ts:23](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L23)

94
website/versioned_docs/version-7.x/api/core/interfaces/searchUtils.SearchPackageItem.md
View file

@ -1,94 +0,0 @@
---
id: 'searchUtils.SearchPackageItem'
title: 'Interface: SearchPackageItem'
sidebar_label: 'searchUtils.SearchPackageItem'
custom_edit_url: null
---
[searchUtils](../namespaces/searchUtils.md).SearchPackageItem
## Hierarchy
- [`UnStable`](../namespaces/searchUtils.md#unstable)
- `PrivatePackage`
↳ **`SearchPackageItem`**
## Properties
### flags
• `Optional` **flags**: `Object`
#### Type declaration
| Name | Type |
| :---------- | :-------- |
| `unstable?` | `boolean` |
#### Inherited from
UnStable.flags
#### Defined in
[search-utils.ts:7](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L7)
---
### package
• **package**: [`SearchPackageBody`](../namespaces/searchUtils.md#searchpackagebody)
#### Defined in
[search-utils.ts:70](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L70)
---
### score
• **score**: [`Score`](../namespaces/searchUtils.md#score)
#### Defined in
[search-utils.ts:71](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L71)
---
### searchScore
• `Optional` **searchScore**: `number`
#### Defined in
[search-utils.ts:72](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L72)
---
### verdaccioPkgCached
• `Optional` **verdaccioPkgCached**: `boolean`
#### Inherited from
PrivatePackage.verdaccioPkgCached
#### Defined in
[search-utils.ts:25](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L25)
---
### verdaccioPrivate
• `Optional` **verdaccioPrivate**: `boolean`
#### Inherited from
PrivatePackage.verdaccioPrivate
#### Defined in
[search-utils.ts:23](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L23)

336
website/versioned_docs/version-7.x/api/core/modules.md
View file

@ -1,336 +0,0 @@
---
id: 'modules'
title: '@verdaccio/core'
sidebar_label: 'Exports'
sidebar_position: 0.5
custom_edit_url: null
---
## Namespaces
- [constants](namespaces/constants.md)
- [errorUtils](namespaces/errorUtils.md)
- [fileUtils](namespaces/fileUtils.md)
- [pkgUtils](namespaces/pkgUtils.md)
- [pluginUtils](namespaces/pluginUtils.md)
- [searchUtils](namespaces/searchUtils.md)
- [streamUtils](namespaces/streamUtils.md)
- [stringUtils](namespaces/stringUtils.md)
- [validatioUtils](namespaces/validatioUtils.md)
- [warningUtils](namespaces/warningUtils.md)
## Enumerations
- [HtpasswdHashAlgorithm](enums/HtpasswdHashAlgorithm.md)
## Type Aliases
### VerdaccioError
Ƭ **VerdaccioError**: `HttpError` & { `code`: `number` }
#### Defined in
[error-utils.ts:57](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L57)
## Variables
### API_ERROR
• `Const` **API_ERROR**: `Object`
#### Type declaration
| Name | Type |
| :---------------------------- | :------- |
| `BAD_AUTH_HEADER` | `string` |
| `BAD_DATA` | `string` |
| `BAD_FORMAT_USER_GROUP` | `string` |
| `BAD_PACKAGE_DATA` | `string` |
| `BAD_STATUS_CODE` | `string` |
| `BAD_USERNAME_PASSWORD` | `string` |
| `CONFIG_BAD_FORMAT` | `string` |
| `CONTENT_MISMATCH` | `string` |
| `DEPRECATED_BASIC_HEADER` | `string` |
| `FILE_NOT_FOUND` | `string` |
| `INTERNAL_SERVER_ERROR` | `string` |
| `MAX_USERS_REACHED` | `string` |
| `MUST_BE_LOGGED` | `string` |
| `NOT_ALLOWED` | `string` |
| `NOT_ALLOWED_PUBLISH` | `string` |
| `NOT_FILE_UPLINK` | `string` |
| `NOT_MODIFIED_NO_DATA` | `string` |
| `NOT_PACKAGE_UPLINK` | `string` |
| `NO_PACKAGE` | `string` |
| `NO_SUCH_FILE` | `string` |
| `PACKAGE_CANNOT_BE_ADDED` | `string` |
| `PACKAGE_EXIST` | `string` |
| `PASSWORD_SHORT` | `string` |
| `PLUGIN_ERROR` | `string` |
| `REGISTRATION_DISABLED` | `string` |
| `RESOURCE_UNAVAILABLE` | `string` |
| `SERVER_TIME_OUT` | `string` |
| `UNAUTHORIZED_ACCESS` | `string` |
| `UNKNOWN_ERROR` | `string` |
| `UNSUPORTED_REGISTRY_CALL` | `string` |
| `UPLINK_OFFLINE` | `string` |
| `UPLINK_OFFLINE_PUBLISH` | `string` |
| `USERNAME_ALREADY_REGISTERED` | `string` |
| `USERNAME_PASSWORD_REQUIRED` | `string` |
| `VERSION_NOT_EXIST` | `string` |
| `WEB_DISABLED` | `string` |
#### Defined in
[error-utils.ts:5](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L5)
---
### API_MESSAGE
• `Const` **API_MESSAGE**: `Object`
#### Type declaration
| Name | Type |
| :----------------- | :------- |
| `LOGGED_OUT` | `string` |
| `OK` | `string` |
| `PKG_CHANGED` | `string` |
| `PKG_CREATED` | `string` |
| `PKG_PUBLISHED` | `string` |
| `PKG_REMOVED` | `string` |
| `TAG_ADDED` | `string` |
| `TAG_REMOVED` | `string` |
| `TAG_UPDATED` | `string` |
| `TARBALL_REMOVED` | `string` |
| `TARBALL_UPLOADED` | `string` |
#### Defined in
[constants.ts:81](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L81)
---
### APP_ERROR
• `Const` **APP_ERROR**: `Object`
#### Type declaration
| Name | Type |
| :-------------------- | :------- |
| `CONFIG_NOT_VALID` | `string` |
| `PASSWORD_VALIDATION` | `string` |
| `PROFILE_ERROR` | `string` |
#### Defined in
[error-utils.ts:51](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L51)
---
### CHARACTER_ENCODING
• `Const` **CHARACTER_ENCODING**: `Object`
#### Type declaration
| Name | Type |
| :----- | :------- |
| `UTF8` | `string` |
#### Defined in
[constants.ts:19](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L19)
---
### DEFAULT_PASSWORD_VALIDATION
• `Const` **DEFAULT_PASSWORD_VALIDATION**: `RegExp`
#### Defined in
[constants.ts:3](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L3)
---
### DEFAULT_USER
• `Const` **DEFAULT_USER**: `"Anonymous"`
#### Defined in
[constants.ts:9](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L9)
---
### DIST_TAGS
• `Const` **DIST_TAGS**: `"dist-tags"`
#### Defined in
[constants.ts:6](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L6)
---
### HEADERS
• `Const` **HEADERS**: `Object`
#### Type declaration
| Name | Type |
| :--------------------- | :------- |
| `ACCEPT` | `string` |
| `ACCEPT_ENCODING` | `string` |
| `AUTHORIZATION` | `string` |
| `CACHE_CONTROL` | `string` |
| `CONTENT_LENGTH` | `string` |
| `CONTENT_TYPE` | `string` |
| `CSP` | `string` |
| `CTO` | `string` |
| `ETAG` | `string` |
| `FORWARDED_FOR` | `string` |
| `FORWARDED_PROTO` | `string` |
| `FRAMES_OPTIONS` | `string` |
| `GZIP` | `string` |
| `JSON` | `string` |
| `JSON_CHARSET` | `string` |
| `JSON_INSTALL_CHARSET` | `string` |
| `NONE_MATCH` | `string` |
| `OCTET_STREAM` | `string` |
| `TEXT_CHARSET` | `string` |
| `TEXT_HTML` | `string` |
| `TEXT_HTML_UTF8` | `string` |
| `TEXT_PLAIN` | `string` |
| `TEXT_PLAIN_UTF8` | `string` |
| `USER_AGENT` | `string` |
| `WWW_AUTH` | `string` |
| `XSS` | `string` |
#### Defined in
[constants.ts:27](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L27)
---
### HEADER_TYPE
• `Const` **HEADER_TYPE**: `Object`
#### Type declaration
| Name | Type |
| :----------------- | :------- |
| `ACCEPT_ENCODING` | `string` |
| `AUTHORIZATION` | `string` |
| `CONTENT_ENCODING` | `string` |
| `CONTENT_LENGTH` | `string` |
| `CONTENT_TYPE` | `string` |
#### Defined in
[constants.ts:11](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L11)
---
### HTTP_STATUS
• `Const` **HTTP_STATUS**: `Object`
#### Type declaration
| Name | Type |
| :-------------------- | :------- |
| `BAD_DATA` | `number` |
| `BAD_REQUEST` | `number` |
| `CANNOT_HANDLE` | `number` |
| `CONFLICT` | `number` |
| `CREATED` | `number` |
| `FORBIDDEN` | `number` |
| `INTERNAL_ERROR` | `number` |
| `LOOP_DETECTED` | `number` |
| `MULTIPLE_CHOICES` | `number` |
| `NOT_FOUND` | `number` |
| `NOT_IMPLEMENTED` | `number` |
| `NOT_MODIFIED` | `number` |
| `OK` | `number` |
| `SERVICE_UNAVAILABLE` | `number` |
| `UNAUTHORIZED` | `number` |
| `UNSUPPORTED_MEDIA` | `number` |
#### Defined in
[constants.ts:58](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L58)
---
### LATEST
• `Const` **LATEST**: `"latest"`
#### Defined in
[constants.ts:7](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L7)
---
### SUPPORT_ERRORS
• `Const` **SUPPORT_ERRORS**: `Object`
#### Type declaration
| Name | Type |
| :------------------------- | :------- |
| `PARAMETERS_NOT_VALID` | `string` |
| `PLUGIN_MISSING_INTERFACE` | `string` |
| `STORAGE_NOT_IMPLEMENT` | `string` |
| `TFA_DISABLED` | `string` |
#### Defined in
[error-utils.ts:44](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L44)
---
### TOKEN_BASIC
• `Const` **TOKEN_BASIC**: `"Basic"`
#### Defined in
[constants.ts:24](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L24)
---
### TOKEN_BEARER
• `Const` **TOKEN_BEARER**: `"Bearer"`
#### Defined in
[constants.ts:25](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L25)
---
### USERS
• `Const` **USERS**: `"users"`
#### Defined in
[constants.ts:8](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L8)
---
### validationUtils
• `Const` **validationUtils**: [`validatioUtils`](namespaces/validatioUtils.md) = `validatioUtils`
#### Defined in
[index.ts:28](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/index.ts#L28)

2
website/versioned_docs/version-7.x/api/core/namespaces/_category_.yml
View file

@ -1,2 +0,0 @@
label: 'Namespaces'
position: 1

190
website/versioned_docs/version-7.x/api/core/namespaces/constants.md
View file

@ -1,190 +0,0 @@
---
id: 'constants'
title: 'Namespace: constants'
sidebar_label: 'constants'
sidebar_position: 0
custom_edit_url: null
---
## References
### API_MESSAGE
Re-exports [API_MESSAGE](../modules.md#api_message)
---
### CHARACTER_ENCODING
Re-exports [CHARACTER_ENCODING](../modules.md#character_encoding)
---
### DEFAULT_PASSWORD_VALIDATION
Re-exports [DEFAULT_PASSWORD_VALIDATION](../modules.md#default_password_validation)
---
### DEFAULT_USER
Re-exports [DEFAULT_USER](../modules.md#default_user)
---
### DIST_TAGS
Re-exports [DIST_TAGS](../modules.md#dist_tags)
---
### HEADERS
Re-exports [HEADERS](../modules.md#headers)
---
### HEADER_TYPE
Re-exports [HEADER_TYPE](../modules.md#header_type)
---
### HTTP_STATUS
Re-exports [HTTP_STATUS](../modules.md#http_status)
---
### HtpasswdHashAlgorithm
Re-exports [HtpasswdHashAlgorithm](../enums/HtpasswdHashAlgorithm.md)
---
### LATEST
Re-exports [LATEST](../modules.md#latest)
---
### TOKEN_BASIC
Re-exports [TOKEN_BASIC](../modules.md#token_basic)
---
### TOKEN_BEARER
Re-exports [TOKEN_BEARER](../modules.md#token_bearer)
---
### USERS
Re-exports [USERS](../modules.md#users)
## Variables
### ERROR_CODE
• `Const` **ERROR_CODE**: `Object`
#### Type declaration
| Name | Type |
| :--------------- | :------- |
| `token_required` | `string` |
#### Defined in
[constants.ts:77](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L77)
---
### LOG_STATUS_MESSAGE
• `Const` **LOG_STATUS_MESSAGE**: `"@{status}, user: @{user}(@{remoteIP}), req: '@{request.method} @{request.url}'"`
#### Defined in
[constants.ts:95](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L95)
---
### LOG_VERDACCIO_BYTES
• `Const` **LOG_VERDACCIO_BYTES**: `string`
#### Defined in
[constants.ts:98](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L98)
---
### LOG_VERDACCIO_ERROR
• `Const` **LOG_VERDACCIO_ERROR**: `string`
#### Defined in
[constants.ts:97](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L97)
---
### PACKAGE_ACCESS
• `Const` **PACKAGE_ACCESS**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------- |
| `ALL` | `string` |
| `SCOPE` | `string` |
#### Defined in
[constants.ts:110](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L110)
---
### ROLES
• `Const` **ROLES**: `Object`
#### Type declaration
| Name | Type |
| :--------------------- | :------- |
| `$ALL` | `string` |
| `$ANONYMOUS` | `string` |
| `$AUTH` | `string` |
| `ALL` | `string` |
| `DEPRECATED_ALL` | `string` |
| `DEPRECATED_ANONYMOUS` | `string` |
| `DEPRECATED_AUTH` | `string` |
#### Defined in
[constants.ts:100](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L100)
---
### TIME_EXPIRATION_1H
• `Const` **TIME_EXPIRATION_1H**: `"1h"`
#### Defined in
[constants.ts:5](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L5)
---
### TIME_EXPIRATION_24H
• `Const` **TIME_EXPIRATION_24H**: `"24h"`
#### Defined in
[constants.ts:4](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/constants.ts#L4)

212
website/versioned_docs/version-7.x/api/core/namespaces/errorUtils.md
View file

@ -1,212 +0,0 @@
---
id: 'errorUtils'
title: 'Namespace: errorUtils'
sidebar_label: 'errorUtils'
sidebar_position: 0
custom_edit_url: null
---
## References
### API_ERROR
Re-exports [API_ERROR](../modules.md#api_error)
---
### APP_ERROR
Re-exports [APP_ERROR](../modules.md#app_error)
---
### SUPPORT_ERRORS
Re-exports [SUPPORT_ERRORS](../modules.md#support_errors)
---
### VerdaccioError
Re-exports [VerdaccioError](../modules.md#verdaccioerror)
## Functions
### getBadData
▸ **getBadData**(`customMessage?`): [`VerdaccioError`](../modules.md#verdaccioerror)
#### Parameters
| Name | Type |
| :--------------- | :------- |
| `customMessage?` | `string` |
#### Returns
[`VerdaccioError`](../modules.md#verdaccioerror)
#### Defined in
[error-utils.ts:71](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L71)
---
### getBadRequest
▸ **getBadRequest**(`customMessage`): [`VerdaccioError`](../modules.md#verdaccioerror)
#### Parameters
| Name | Type |
| :-------------- | :------- |
| `customMessage` | `string` |
#### Returns
[`VerdaccioError`](../modules.md#verdaccioerror)
#### Defined in
[error-utils.ts:75](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L75)
---
### getCode
▸ **getCode**(`statusCode`, `customMessage`): [`VerdaccioError`](../modules.md#verdaccioerror)
#### Parameters
| Name | Type |
| :-------------- | :------- |
| `statusCode` | `number` |
| `customMessage` | `string` |
#### Returns
[`VerdaccioError`](../modules.md#verdaccioerror)
#### Defined in
[error-utils.ts:103](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L103)
---
### getConflict
▸ **getConflict**(`message?`): [`VerdaccioError`](../modules.md#verdaccioerror)
#### Parameters
| Name | Type | Default value |
| :-------- | :------- | :------------------------ |
| `message` | `string` | `API_ERROR.PACKAGE_EXIST` |
#### Returns
[`VerdaccioError`](../modules.md#verdaccioerror)
#### Defined in
[error-utils.ts:67](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L67)
---
### getForbidden
▸ **getForbidden**(`message?`): [`VerdaccioError`](../modules.md#verdaccioerror)
#### Parameters
| Name | Type | Default value |
| :-------- | :------- | :-------------------------- |
| `message` | `string` | `"can't use this filename"` |
#### Returns
[`VerdaccioError`](../modules.md#verdaccioerror)
#### Defined in
[error-utils.ts:89](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L89)
---
### getInternalError
▸ **getInternalError**(`customMessage?`): [`VerdaccioError`](../modules.md#verdaccioerror)
#### Parameters
| Name | Type |
| :--------------- | :------- |
| `customMessage?` | `string` |
#### Returns
[`VerdaccioError`](../modules.md#verdaccioerror)
#### Defined in
[error-utils.ts:79](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L79)
---
### getNotFound
▸ **getNotFound**(`customMessage?`): [`VerdaccioError`](../modules.md#verdaccioerror)
#### Parameters
| Name | Type |
| :--------------- | :------- |
| `customMessage?` | `string` |
#### Returns
[`VerdaccioError`](../modules.md#verdaccioerror)
#### Defined in
[error-utils.ts:99](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L99)
---
### getServiceUnavailable
▸ **getServiceUnavailable**(`message?`): [`VerdaccioError`](../modules.md#verdaccioerror)
#### Parameters
| Name | Type | Default value |
| :-------- | :------- | :------------------------------- |
| `message` | `string` | `API_ERROR.RESOURCE_UNAVAILABLE` |
#### Returns
[`VerdaccioError`](../modules.md#verdaccioerror)
#### Defined in
[error-utils.ts:93](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L93)
---
### getUnauthorized
▸ **getUnauthorized**(`message?`): [`VerdaccioError`](../modules.md#verdaccioerror)
#### Parameters
| Name | Type | Default value |
| :-------- | :------- | :-------------------------- |
| `message` | `string` | `'no credentials provided'` |
#### Returns
[`VerdaccioError`](../modules.md#verdaccioerror)
#### Defined in
[error-utils.ts:85](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/error-utils.ts#L85)

70
website/versioned_docs/version-7.x/api/core/namespaces/fileUtils.md
View file

@ -1,70 +0,0 @@
---
id: 'fileUtils'
title: 'Namespace: fileUtils'
sidebar_label: 'fileUtils'
sidebar_position: 0
custom_edit_url: null
---
## Variables
### Files
• `Const` **Files**: `Object`
#### Type declaration
| Name | Type |
| :------------- | :------- |
| `DatabaseName` | `string` |
#### Defined in
[file-utils.ts:5](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/file-utils.ts#L5)
## Functions
### createTempFolder
▸ **createTempFolder**(`prefix`): `Promise`<`string`\>
Create a temporary folder.
#### Parameters
| Name | Type | Description |
| :------- | :------- | :----------------------------- |
| `prefix` | `string` | The prefix of the folder name. |
#### Returns
`Promise`<`string`\>
string
#### Defined in
[file-utils.ts:16](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/file-utils.ts#L16)
---
### createTempStorageFolder
▸ **createTempStorageFolder**(`prefix`, `folder?`): `Promise`<`string`\>
Create temporary folder for an asset.
#### Parameters
| Name | Type | Default value | Description |
| :------- | :------- | :------------ | :---------- |
| `prefix` | `string` | `undefined` | |
| `folder` | `string` | `'storage'` | name |
#### Returns
`Promise`<`string`\>
#### Defined in
[file-utils.ts:26](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/file-utils.ts#L26)

106
website/versioned_docs/version-7.x/api/core/namespaces/pkgUtils.md
View file

@ -1,106 +0,0 @@
---
id: 'pkgUtils'
title: 'Namespace: pkgUtils'
sidebar_label: 'pkgUtils'
sidebar_position: 0
custom_edit_url: null
---
## Functions
### extractTarballName
▸ **extractTarballName**(`tarball`): `any`
Extract the tarball name from a registry dist url
'https://registry.npmjs.org/test/-/test-0.0.2.tgz'
#### Parameters
| Name | Type | Description |
| :-------- | :------- | :---------- |
| `tarball` | `string` | tarball url |
#### Returns
`any`
tarball filename
#### Defined in
[pkg-utils.ts:14](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/pkg-utils.ts#L14)
---
### getLatest
▸ **getLatest**(`pkg`): `string`
Get the latest publihsed version of a package.
#### Parameters
| Name | Type |
| :---- | :--------- |
| `pkg` | `Manifest` |
#### Returns
`string`
#### Defined in
[pkg-utils.ts:40](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/pkg-utils.ts#L40)
---
### mergeVersions
▸ **mergeVersions**(`local`, `upstream`): `void`
Function gets a local info and an info from uplinks and tries to merge it
exported for unit tests only.
- **`Deprecated`**
use @verdaccio/storage mergeVersions method
#### Parameters
| Name | Type | Description |
| :--------- | :--------- | :---------- |
| `local` | `Manifest` | \* |
| `upstream` | `Manifest` | \* |
#### Returns
`void`
#### Defined in
[pkg-utils.ts:61](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/pkg-utils.ts#L61)
---
### semverSort
▸ **semverSort**(`listVersions`): `string`[]
Function filters out bad semver versions and sorts the array.
#### Parameters
| Name | Type |
| :------------- | :--------- |
| `listVersions` | `string`[] |
#### Returns
`string`[]
sorted Array
#### Defined in
[pkg-utils.ts:24](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/pkg-utils.ts#L24)

149
website/versioned_docs/version-7.x/api/core/namespaces/pluginUtils.md
View file

@ -1,149 +0,0 @@
---
id: 'pluginUtils'
title: 'Namespace: pluginUtils'
sidebar_label: 'pluginUtils'
sidebar_position: 0
custom_edit_url: null
---
## Classes
- [Plugin](../classes/pluginUtils.Plugin.md)
## Interfaces
- [Auth](../interfaces/pluginUtils.Auth.md)
- [AuthPluginPackage](../interfaces/pluginUtils.AuthPluginPackage.md)
- [ExpressMiddleware](../interfaces/pluginUtils.ExpressMiddleware.md)
- [IBasicAuth](../interfaces/pluginUtils.IBasicAuth.md)
- [ManifestFilter](../interfaces/pluginUtils.ManifestFilter.md)
- [PluginOptions](../interfaces/pluginUtils.PluginOptions.md)
- [Storage](../interfaces/pluginUtils.Storage.md)
- [StorageHandler](../interfaces/pluginUtils.StorageHandler.md)
## Type Aliases
### AccessCallback
Ƭ **AccessCallback**: (`error`: [`VerdaccioError`](../modules.md#verdaccioerror) \| `null`, `ok?`: `boolean`) => `void`
#### Type declaration
▸ (`error`, `ok?`): `void`
##### Parameters
| Name | Type |
| :------ | :--------------------------------------------------------- |
| `error` | [`VerdaccioError`](../modules.md#verdaccioerror) \| `null` |
| `ok?` | `boolean` |
##### Returns
`void`
#### Defined in
[plugin-utils.ts:115](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L115)
---
### AuthAccessCallback
Ƭ **AuthAccessCallback**: (`error`: [`VerdaccioError`](../modules.md#verdaccioerror) \| `null`, `access?`: `boolean`) => `void`
#### Type declaration
▸ (`error`, `access?`): `void`
##### Parameters
| Name | Type |
| :-------- | :--------------------------------------------------------- |
| `error` | [`VerdaccioError`](../modules.md#verdaccioerror) \| `null` |
| `access?` | `boolean` |
##### Returns
`void`
#### Defined in
[plugin-utils.ts:112](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L112)
---
### AuthCallback
Ƭ **AuthCallback**: (`error`: [`VerdaccioError`](../modules.md#verdaccioerror) \| `null`, `groups?`: `string`[] \| `false`) => `void`
#### Type declaration
▸ (`error`, `groups?`): `void`
dasdsa
##### Parameters
| Name | Type |
| :-------- | :--------------------------------------------------------- |
| `error` | [`VerdaccioError`](../modules.md#verdaccioerror) \| `null` |
| `groups?` | `string`[] \| `false` |
##### Returns
`void`
#### Defined in
[plugin-utils.ts:110](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L110)
---
### AuthChangePasswordCallback
Ƭ **AuthChangePasswordCallback**: (`error`: [`VerdaccioError`](../modules.md#verdaccioerror) \| `null`, `access?`: `boolean`) => `void`
#### Type declaration
▸ (`error`, `access?`): `void`
##### Parameters
| Name | Type |
| :-------- | :--------------------------------------------------------- |
| `error` | [`VerdaccioError`](../modules.md#verdaccioerror) \| `null` |
| `access?` | `boolean` |
##### Returns
`void`
#### Defined in
[plugin-utils.ts:114](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L114)
---
### AuthUserCallback
Ƭ **AuthUserCallback**: (`error`: [`VerdaccioError`](../modules.md#verdaccioerror) \| `null`, `access?`: `boolean` \| `string`) => `void`
#### Type declaration
▸ (`error`, `access?`): `void`
##### Parameters
| Name | Type |
| :-------- | :--------------------------------------------------------- |
| `error` | [`VerdaccioError`](../modules.md#verdaccioerror) \| `null` |
| `access?` | `boolean` \| `string` |
##### Returns
`void`
#### Defined in
[plugin-utils.ts:113](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/plugin-utils.ts#L113)

150
website/versioned_docs/version-7.x/api/core/namespaces/searchUtils.md
View file

@ -1,150 +0,0 @@
---
id: 'searchUtils'
title: 'Namespace: searchUtils'
sidebar_label: 'searchUtils'
sidebar_position: 0
custom_edit_url: null
---
## Interfaces
- [SearchItem](../interfaces/searchUtils.SearchItem.md)
- [SearchPackageItem](../interfaces/searchUtils.SearchPackageItem.md)
## Type Aliases
### Score
Ƭ **Score**: `Object`
#### Type declaration
| Name | Type |
| :------- | :---------------------------------------------- |
| `detail` | [`SearchMetrics`](searchUtils.md#searchmetrics) |
| `final` | `number` |
#### Defined in
[search-utils.ts:33](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L33)
---
### SearchItemPkg
Ƭ **SearchItemPkg**: `Object`
#### Type declaration
| Name | Type |
| :-------- | :----------------- |
| `name` | `string` |
| `path?` | `string` |
| `scoped?` | `string` |
| `time?` | `number` \| `Date` |
#### Defined in
[search-utils.ts:12](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L12)
---
### SearchMetrics
Ƭ **SearchMetrics**: `Object`
#### Type declaration
| Name | Type |
| :------------ | :------- |
| `maintenance` | `number` |
| `popularity` | `number` |
| `quality` | `number` |
#### Defined in
[search-utils.ts:1](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L1)
---
### SearchPackageBody
Ƭ **SearchPackageBody**: `Object`
#### Type declaration
| Name | Type |
| :------------------ | :---------------------------------------------------------------------------------------- |
| `author` | `string` \| `PublisherMaintainer` |
| `date` | `string` |
| `description` | `string` |
| `keywords` | `string` \| `string`[] \| `undefined` |
| `links?` | { `bugs?`: `string` ; `homepage?`: `string` ; `npm`: `string` ; `repository?`: `string` } |
| `links.bugs?` | `string` |
| `links.homepage?` | `string` |
| `links.npm` | `string` |
| `links.repository?` | `string` |
| `maintainers?` | `PublisherMaintainer`[] |
| `name` | `string` |
| `publisher?` | `any` |
| `scope` | `string` |
| `version` | `string` |
#### Defined in
[search-utils.ts:51](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L51)
---
### SearchQuery
Ƭ **SearchQuery**: { `from?`: `number` ; `size?`: `number` ; `text`: `string` } & [`SearchMetrics`](searchUtils.md#searchmetrics)
#### Defined in
[search-utils.ts:77](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L77)
---
### SearchResults
Ƭ **SearchResults**: `Object`
#### Type declaration
| Name | Type |
| :-------- | :------------------------------------------------ |
| `objects` | [`SearchItemPkg`](searchUtils.md#searchitempkg)[] |
| `time` | `string` |
| `total` | `number` |
#### Defined in
[search-utils.ts:38](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L38)
---
### UnStable
Ƭ **UnStable**: `Object`
#### Type declaration
| Name | Type |
| :---------------- | :------------------------- |
| `flags?` | { `unstable?`: `boolean` } |
| `flags.unstable?` | `boolean` |
#### Defined in
[search-utils.ts:6](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L6)
## Variables
### UNSCOPED
• `Const` **UNSCOPED**: `"unscoped"`
#### Defined in
[search-utils.ts:75](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/search-utils.ts#L75)

45
website/versioned_docs/version-7.x/api/core/namespaces/streamUtils.md
View file

@ -1,45 +0,0 @@
---
id: 'streamUtils'
title: 'Namespace: streamUtils'
sidebar_label: 'streamUtils'
sidebar_position: 0
custom_edit_url: null
---
## Functions
### readableToString
▸ **readableToString**(`stream`): `Promise`<`string`\>
Converts a buffer stream to a string.
#### Parameters
| Name | Type |
| :------- | :--------- |
| `stream` | `Readable` |
#### Returns
`Promise`<`string`\>
#### Defined in
[stream-utils.ts:6](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/stream-utils.ts#L6)
---
### transformObjectToString
▸ **transformObjectToString**(): `Transform`
Transform stream object mode to string
#### Returns
`Transform`
#### Defined in
[stream-utils.ts:19](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/stream-utils.ts#L19)

32
website/versioned_docs/version-7.x/api/core/namespaces/stringUtils.md
View file

@ -1,32 +0,0 @@
---
id: 'stringUtils'
title: 'Namespace: stringUtils'
sidebar_label: 'stringUtils'
sidebar_position: 0
custom_edit_url: null
---
## Functions
### getByQualityPriorityValue
▸ **getByQualityPriorityValue**(`headerValue`): `string`
Quality values, or q-values and q-factors, are used to describe the order
of priority of values in a comma-separated list.
It is a special syntax allowed in some HTTP headers and in HTML.
https://developer.mozilla.org/en-US/docs/Glossary/Quality_values
#### Parameters
| Name | Type |
| :------------ | :-------------------------------- |
| `headerValue` | `undefined` \| `null` \| `string` |
#### Returns
`string`
#### Defined in
[string-utils.ts:8](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/string-utils.ts#L8)

170
website/versioned_docs/version-7.x/api/core/namespaces/validatioUtils.md
View file

@ -1,170 +0,0 @@
---
id: 'validatioUtils'
title: 'Namespace: validatioUtils'
sidebar_label: 'validatioUtils'
sidebar_position: 0
custom_edit_url: null
---
## Functions
### isObject
▸ **isObject**(`obj`): `boolean`
Check whether an element is an Object
#### Parameters
| Name | Type | Description |
| :---- | :---- | :---------- |
| `obj` | `any` | the element |
#### Returns
`boolean`
#### Defined in
[validation-utils.ts:97](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/validation-utils.ts#L97)
---
### isPackageNameScoped
▸ **isPackageNameScoped**(`name`): `boolean`
#### Parameters
| Name | Type |
| :----- | :------- |
| `name` | `string` |
#### Returns
`boolean`
#### Defined in
[validation-utils.ts:9](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/validation-utils.ts#L9)
---
### normalizeMetadata
▸ **normalizeMetadata**(`manifest`, `name`): `Manifest`
Validate the package metadata, add additional properties whether are missing within
the metadata properties.
#### Parameters
| Name | Type |
| :--------- | :--------- |
| `manifest` | `Manifest` |
| `name` | `string` |
#### Returns
`Manifest`
the object with additional properties as dist-tags ad versions
FUTURE: rename to normalizeMetadata
#### Defined in
[validation-utils.ts:72](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/validation-utils.ts#L72)
---
### validateName
▸ **validateName**(`name`): `boolean`
From normalize-package-data/lib/fixer.js
#### Parameters
| Name | Type | Description |
| :----- | :------- | :--------------- |
| `name` | `string` | the package name |
#### Returns
`boolean`
whether is valid or not
#### Defined in
[validation-utils.ts:18](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/validation-utils.ts#L18)
---
### validatePackage
▸ **validatePackage**(`name`): `boolean`
Validate a package.
#### Parameters
| Name | Type |
| :----- | :------- |
| `name` | `string` |
#### Returns
`boolean`
whether the package is valid or not
#### Defined in
[validation-utils.ts:54](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/validation-utils.ts#L54)
---
### validatePassword
▸ **validatePassword**(`password`, `validation?`): `boolean`
#### Parameters
| Name | Type | Default value |
| :----------- | :------- | :---------------------------- |
| `password` | `string` | `undefined` |
| `validation` | `RegExp` | `DEFAULT_PASSWORD_VALIDATION` |
#### Returns
`boolean`
#### Defined in
[validation-utils.ts:109](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/validation-utils.ts#L109)
---
### validatePublishSingleVersion
▸ **validatePublishSingleVersion**(`manifest`): `boolean`
Validate if a manifest has the correct structure when a new package
is being created. The properties name, versions and \_attachments must contain 1 element.
#### Parameters
| Name | Type |
| :--------- | :---- |
| `manifest` | `any` |
#### Returns
`boolean`
boolean
#### Defined in
[schemes/publish-manifest.ts:33](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/schemes/publish-manifest.ts#L33)

34
website/versioned_docs/version-7.x/api/core/namespaces/warningUtils.md
View file

@ -1,34 +0,0 @@
---
id: 'warningUtils'
title: 'Namespace: warningUtils'
sidebar_label: 'warningUtils'
sidebar_position: 0
custom_edit_url: null
---
## Enumerations
- [Codes](../enums/warningUtils.Codes.md)
## Functions
### emit
▸ **emit**(`code`, `a?`, `b?`, `c?`): `void`
#### Parameters
| Name | Type |
| :----- | :------- |
| `code` | `string` |
| `a?` | `string` |
| `b?` | `string` |
| `c?` | `string` |
#### Returns
`void`
#### Defined in
[warning-utils.ts:55](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/core/src/warning-utils.ts#L55)

3
website/versioned_docs/version-7.x/api/index.md
View file

@ -1,3 +0,0 @@
# Verdaccio API
TBA

1
website/versioned_docs/version-7.x/api/node-api/_category_.yml
View file

@ -1 +0,0 @@
label: '@verdaccio/node-api'

16
website/versioned_docs/version-7.x/api/node-api/index.md
View file

@ -1,16 +0,0 @@
---
id: 'index'
title: '@verdaccio/node-api'
sidebar_label: 'Readme'
sidebar_position: 0
custom_edit_url: null
---
# @verdaccio/node-api
### License
Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch) files within the /assets folder) is
[Creative Commons licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE-docs).

63
website/versioned_docs/version-7.x/api/node-api/modules.md
View file

@ -1,63 +0,0 @@
---
id: 'modules'
title: '@verdaccio/node-api'
sidebar_label: 'Exports'
sidebar_position: 0.5
custom_edit_url: 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](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/node-api/src/server.ts#L103)
---
### runServer
▸ **runServer**(`config?`): `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
});
```
#### Parameters
| Name | Type |
| :-------- | :----------------------- |
| `config?` | `string` \| `ConfigYaml` |
#### Returns
`Promise`<`any`\>
#### Defined in
[server.ts:186](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/node-api/src/server.ts#L186)

1
website/versioned_docs/version-7.x/api/types/_category_.yml
View file

@ -1 +0,0 @@
label: '@verdaccio/types'

11
website/versioned_docs/version-7.x/api/types/index.md
View file

@ -1,11 +0,0 @@
---
id: 'index'
title: '@verdaccio/types - v12.0.0-next.0'
sidebar_label: 'Readme'
sidebar_position: 0
custom_edit_url: null
---
# @verdaccio/types
TypeScript definitions for Verdaccio plugins and internal code.

27
website/versioned_docs/version-7.x/api/types/interfaces/APITokenOptions.md
View file

@ -1,27 +0,0 @@
---
id: 'APITokenOptions'
title: 'Interface: APITokenOptions'
sidebar_label: 'APITokenOptions'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### jwt
• `Optional` **jwt**: [`JWTOptions`](JWTOptions.md)
#### Defined in
[packages/core/types/src/configuration.ts:173](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L173)
---
### legacy
• **legacy**: `boolean`
#### Defined in
[packages/core/types/src/configuration.ts:172](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L172)

11
website/versioned_docs/version-7.x/api/types/interfaces/AbbreviatedVersions.md
View file

@ -1,11 +0,0 @@
---
id: 'AbbreviatedVersions'
title: 'Interface: AbbreviatedVersions'
sidebar_label: 'AbbreviatedVersions'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: [`AbbreviatedVersion`](../modules.md#abbreviatedversion)

43
website/versioned_docs/version-7.x/api/types/interfaces/AllowAccess.md
View file

@ -1,43 +0,0 @@
---
id: 'AllowAccess'
title: 'Interface: AllowAccess'
sidebar_label: 'AllowAccess'
sidebar_position: 0
custom_edit_url: null
---
## Hierarchy
- **`AllowAccess`**
↳ [`AuthPackageAllow`](AuthPackageAllow.md)
## Properties
### name
• **name**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:294](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L294)
---
### tag
• `Optional` **tag**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:296](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L296)
---
### version
• `Optional` **version**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:295](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L295)

11
website/versioned_docs/version-7.x/api/types/interfaces/AttachMents.md
View file

@ -1,11 +0,0 @@
---
id: 'AttachMents'
title: 'Interface: AttachMents'
sidebar_label: 'AttachMents'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: [`AttachMentsItem`](AttachMentsItem.md)

57
website/versioned_docs/version-7.x/api/types/interfaces/AttachMentsItem.md
View file

@ -1,57 +0,0 @@
---
id: 'AttachMentsItem'
title: 'Interface: AttachMentsItem'
sidebar_label: 'AttachMentsItem'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### content_type
• `Optional` **content_type**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:42](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L42)
---
### data
• `Optional` **data**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:43](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L43)
---
### length
• `Optional` **length**: `number`
#### Defined in
[packages/core/types/src/manifest.ts:44](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L44)
---
### shasum
• `Optional` **shasum**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:45](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L45)
---
### version
• `Optional` **version**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:46](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L46)

27
website/versioned_docs/version-7.x/api/types/interfaces/AuthHtpasswd.md
View file

@ -1,27 +0,0 @@
---
id: 'AuthHtpasswd'
title: 'Interface: AuthHtpasswd'
sidebar_label: 'AuthHtpasswd'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### file
• **file**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:142](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L142)
---
### max_users
• **max_users**: `number`
#### Defined in
[packages/core/types/src/configuration.ts:143](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L143)

127
website/versioned_docs/version-7.x/api/types/interfaces/AuthPackageAllow.md
View file

@ -1,127 +0,0 @@
---
id: 'AuthPackageAllow'
title: 'Interface: AuthPackageAllow'
sidebar_label: 'AuthPackageAllow'
sidebar_position: 0
custom_edit_url: null
---
## Hierarchy
- [`PackageAccess`](PackageAccess.md)
- [`AllowAccess`](AllowAccess.md)
↳ **`AuthPackageAllow`**
## Properties
### access
• `Optional` **access**: `string`[]
#### Inherited from
[PackageAccess](PackageAccess.md).[access](PackageAccess.md#access)
#### Defined in
[packages/core/types/src/manifest.ts:5](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L5)
---
### name
• **name**: `string`
#### Inherited from
[AllowAccess](AllowAccess.md).[name](AllowAccess.md#name)
#### Defined in
[packages/core/types/src/configuration.ts:294](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L294)
---
### proxy
• `Optional` **proxy**: `string`[]
#### Inherited from
[PackageAccess](PackageAccess.md).[proxy](PackageAccess.md#proxy)
#### Defined in
[packages/core/types/src/manifest.ts:4](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L4)
---
### publish
• `Optional` **publish**: `string`[]
#### Inherited from
[PackageAccess](PackageAccess.md).[publish](PackageAccess.md#publish)
#### Defined in
[packages/core/types/src/manifest.ts:3](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L3)
---
### storage
• `Optional` **storage**: `string`
#### Inherited from
[PackageAccess](PackageAccess.md).[storage](PackageAccess.md#storage)
#### Defined in
[packages/core/types/src/manifest.ts:2](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L2)
---
### tag
• `Optional` **tag**: `string`
#### Inherited from
[AllowAccess](AllowAccess.md).[tag](AllowAccess.md#tag)
#### Defined in
[packages/core/types/src/configuration.ts:296](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L296)
---
### unpublish
• **unpublish**: `string`[]
#### Inherited from
[PackageAccess](PackageAccess.md).[unpublish](PackageAccess.md#unpublish)
#### Defined in
[packages/core/types/src/manifest.ts:6](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L6)
---
### version
• `Optional` **version**: `string`
#### Inherited from
[AllowAccess](AllowAccess.md).[version](AllowAccess.md#version)
#### Defined in
[packages/core/types/src/configuration.ts:295](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L295)

47
website/versioned_docs/version-7.x/api/types/interfaces/Author.md
View file

@ -1,47 +0,0 @@
---
id: 'Author'
title: 'Interface: Author'
sidebar_label: 'Author'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### email
• `Optional` **email**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:80](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L80)
---
### name
• **name**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:79](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L79)
---
### url
• `Optional` **url**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:81](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L81)
---
### username
• `Optional` **username**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:78](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L78)

509
website/versioned_docs/version-7.x/api/types/interfaces/Config.md
View file

@ -1,509 +0,0 @@
---
id: 'Config'
title: 'Interface: Config'
sidebar_label: 'Config'
sidebar_position: 0
custom_edit_url: null
---
Configuration object with additional methods for configuration, includes yaml and internal medatada.
**`Interface`**
Config
## Hierarchy
- `Omit`<[`ConfigYaml`](ConfigYaml.md), `"packages"` \| `"security"` \| `"configPath"`\>
↳ **`Config`**
↳↳ [`ConfigWithHttps`](ConfigWithHttps.md)
## Indexable
▪ [key: `string`]: `any`
## Properties
### \_debug
• `Optional` **\_debug**: `boolean`
#### Inherited from
Omit.\_debug
#### Defined in
[packages/core/types/src/configuration.ts:234](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L234)
---
### auth
• `Optional` **auth**: `any`
#### Inherited from
Omit.auth
#### Defined in
[packages/core/types/src/configuration.ts:242](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L242)
---
### configPath
• **configPath**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:279](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L279)
---
### experiments
• `Optional` **experiments**: [`FlagsConfig`](../modules.md#flagsconfig)
#### Inherited from
Omit.experiments
#### Defined in
[packages/core/types/src/configuration.ts:262](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L262)
---
### filters
• `Optional` **filters**: `any`
#### Inherited from
Omit.filters
#### Defined in
[packages/core/types/src/configuration.ts:257](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L257)
---
### flags
• `Optional` **flags**: [`FlagsConfig`](../modules.md#flagsconfig)
#### Inherited from
Omit.flags
#### Defined in
[packages/core/types/src/configuration.ts:260](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L260)
---
### http_proxy
• `Optional` **http_proxy**: `string`
#### Inherited from
Omit.http_proxy
#### Defined in
[packages/core/types/src/configuration.ts:249](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L249)
---
### https
• `Optional` **https**: [`HttpsConf`](../modules.md#httpsconf)
#### Inherited from
Omit.https
#### Defined in
[packages/core/types/src/configuration.ts:247](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L247)
---
### https_proxy
• `Optional` **https_proxy**: `string`
#### Inherited from
Omit.https_proxy
#### Defined in
[packages/core/types/src/configuration.ts:251](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L251)
---
### i18n
• `Optional` **i18n**: `Object`
#### Type declaration
| Name | Type |
| :---- | :------- |
| `web` | `string` |
#### Inherited from
Omit.i18n
#### Defined in
[packages/core/types/src/configuration.ts:267](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L267)
---
### listen
• `Optional` **listen**: [`ListenAddress`](ListenAddress.md)
#### Inherited from
Omit.listen
#### Defined in
[packages/core/types/src/configuration.ts:246](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L246)
---
### log
• `Optional` **log**: [`LoggerConfItem`](LoggerConfItem.md)
#### Inherited from
Omit.log
#### Defined in
[packages/core/types/src/configuration.ts:238](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L238)
---
### logs
• `Optional` **logs**: [`LoggerConfItem`](LoggerConfItem.md)
#### Inherited from
Omit.logs
#### Defined in
[packages/core/types/src/configuration.ts:240](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L240)
---
### max_body_size
• `Optional` **max_body_size**: `string`
#### Inherited from
Omit.max_body_size
#### Defined in
[packages/core/types/src/configuration.ts:253](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L253)
---
### middlewares
• `Optional` **middlewares**: `any`
#### Inherited from
Omit.middlewares
#### Defined in
[packages/core/types/src/configuration.ts:256](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L256)
---
### no_proxy
• `Optional` **no_proxy**: `string`
#### Inherited from
Omit.no_proxy
#### Defined in
[packages/core/types/src/configuration.ts:252](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L252)
---
### notifications
• `Optional` **notifications**: [`Notifications`](Notifications.md)
#### Inherited from
Omit.notifications
#### Defined in
[packages/core/types/src/configuration.ts:254](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L254)
---
### notify
• `Optional` **notify**: [`Notifications`](Notifications.md) \| [`Notifications`](Notifications.md)[]
#### Inherited from
Omit.notify
#### Defined in
[packages/core/types/src/configuration.ts:255](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L255)
---
### packages
• **packages**: [`PackageList`](PackageList.md)
#### Defined in
[packages/core/types/src/configuration.ts:283](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L283)
---
### plugins
• `Optional` **plugins**: `null` \| `string` \| `void`
#### Inherited from
Omit.plugins
#### Defined in
[packages/core/types/src/configuration.ts:250](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L250)
---
### publish
• `Optional` **publish**: [`PublishOptions`](PublishOptions.md)
#### Inherited from
Omit.publish
#### Defined in
[packages/core/types/src/configuration.ts:244](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L244)
---
### secret
• **secret**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:277](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L277)
---
### security
• **security**: [`Security`](Security.md)
#### Defined in
[packages/core/types/src/configuration.ts:285](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L285)
---
### self_path
• `Optional` **self_path**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:281](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L281)
---
### server
• `Optional` **server**: [`ServerSettingsConf`](../modules.md#serversettingsconf)
#### Inherited from
Omit.server
#### Defined in
[packages/core/types/src/configuration.ts:259](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L259)
---
### server_id
• **server_id**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:276](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L276)
---
### storage
• `Optional` **storage**: `string` \| `void`
#### Inherited from
Omit.storage
#### Defined in
[packages/core/types/src/configuration.ts:235](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L235)
---
### store
• `Optional` **store**: `any`
#### Inherited from
Omit.store
#### Defined in
[packages/core/types/src/configuration.ts:245](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L245)
---
### uplinks
• **uplinks**: [`UpLinksConfList`](UpLinksConfList.md)
#### Inherited from
Omit.uplinks
#### Defined in
[packages/core/types/src/configuration.ts:237](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L237)
---
### url_prefix
• `Optional` **url_prefix**: `string`
#### Inherited from
Omit.url_prefix
#### Defined in
[packages/core/types/src/configuration.ts:258](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L258)
---
### userRateLimit
• `Optional` **userRateLimit**: [`RateLimit`](../modules.md#ratelimit)
#### Inherited from
Omit.userRateLimit
#### Defined in
[packages/core/types/src/configuration.ts:263](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L263)
---
### user_agent
• `Optional` **user_agent**: `string`
#### Inherited from
Omit.user_agent
#### Defined in
[packages/core/types/src/configuration.ts:248](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L248)
---
### web
• `Optional` **web**: [`WebConf`](../modules.md#webconf)
#### Inherited from
Omit.web
#### Defined in
[packages/core/types/src/configuration.ts:241](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L241)
## Methods
### checkSecretKey
▸ **checkSecretKey**(`token`): `string`
#### Parameters
| Name | Type |
| :------ | :------- |
| `token` | `string` |
#### Returns
`string`
#### Defined in
[packages/core/types/src/configuration.ts:287](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L287)
---
### getMatchedPackagesSpec
▸ **getMatchedPackagesSpec**(`storage`): `void` \| [`PackageAccess`](PackageAccess.md)
#### Parameters
| Name | Type |
| :-------- | :------- |
| `storage` | `string` |
#### Returns
`void` \| [`PackageAccess`](PackageAccess.md)
#### Defined in
[packages/core/types/src/configuration.ts:288](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L288)

535
website/versioned_docs/version-7.x/api/types/interfaces/ConfigWithHttps.md
View file

@ -1,535 +0,0 @@
---
id: 'ConfigWithHttps'
title: 'Interface: ConfigWithHttps'
sidebar_label: 'ConfigWithHttps'
sidebar_position: 0
custom_edit_url: null
---
Configuration object with additional methods for configuration, includes yaml and internal medatada.
**`Interface`**
Config
## Hierarchy
- [`Config`](Config.md)
↳ **`ConfigWithHttps`**
## Properties
### \_debug
• `Optional` **\_debug**: `boolean`
#### Inherited from
[Config](Config.md).[\_debug](Config.md#_debug)
#### Defined in
[packages/core/types/src/configuration.ts:234](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L234)
---
### auth
• `Optional` **auth**: `any`
#### Inherited from
[Config](Config.md).[auth](Config.md#auth)
#### Defined in
[packages/core/types/src/configuration.ts:242](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L242)
---
### configPath
• **configPath**: `string`
#### Inherited from
[Config](Config.md).[configPath](Config.md#configpath)
#### Defined in
[packages/core/types/src/configuration.ts:279](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L279)
---
### experiments
• `Optional` **experiments**: [`FlagsConfig`](../modules.md#flagsconfig)
#### Inherited from
[Config](Config.md).[experiments](Config.md#experiments)
#### Defined in
[packages/core/types/src/configuration.ts:262](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L262)
---
### filters
• `Optional` **filters**: `any`
#### Inherited from
[Config](Config.md).[filters](Config.md#filters)
#### Defined in
[packages/core/types/src/configuration.ts:257](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L257)
---
### flags
• `Optional` **flags**: [`FlagsConfig`](../modules.md#flagsconfig)
#### Inherited from
[Config](Config.md).[flags](Config.md#flags)
#### Defined in
[packages/core/types/src/configuration.ts:260](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L260)
---
### http_proxy
• `Optional` **http_proxy**: `string`
#### Inherited from
[Config](Config.md).[http_proxy](Config.md#http_proxy)
#### Defined in
[packages/core/types/src/configuration.ts:249](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L249)
---
### https
• **https**: [`HttpsConf`](../modules.md#httpsconf)
#### Overrides
[Config](Config.md).[https](Config.md#https)
#### Defined in
[packages/core/types/src/configuration.ts:29](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L29)
---
### https_proxy
• `Optional` **https_proxy**: `string`
#### Inherited from
[Config](Config.md).[https_proxy](Config.md#https_proxy)
#### Defined in
[packages/core/types/src/configuration.ts:251](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L251)
---
### i18n
• `Optional` **i18n**: `Object`
#### Type declaration
| Name | Type |
| :---- | :------- |
| `web` | `string` |
#### Inherited from
[Config](Config.md).[i18n](Config.md#i18n)
#### Defined in
[packages/core/types/src/configuration.ts:267](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L267)
---
### listen
• `Optional` **listen**: [`ListenAddress`](ListenAddress.md)
#### Inherited from
[Config](Config.md).[listen](Config.md#listen)
#### Defined in
[packages/core/types/src/configuration.ts:246](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L246)
---
### log
• `Optional` **log**: [`LoggerConfItem`](LoggerConfItem.md)
#### Inherited from
[Config](Config.md).[log](Config.md#log)
#### Defined in
[packages/core/types/src/configuration.ts:238](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L238)
---
### logs
• `Optional` **logs**: [`LoggerConfItem`](LoggerConfItem.md)
#### Inherited from
[Config](Config.md).[logs](Config.md#logs)
#### Defined in
[packages/core/types/src/configuration.ts:240](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L240)
---
### max_body_size
• `Optional` **max_body_size**: `string`
#### Inherited from
[Config](Config.md).[max_body_size](Config.md#max_body_size)
#### Defined in
[packages/core/types/src/configuration.ts:253](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L253)
---
### middlewares
• `Optional` **middlewares**: `any`
#### Inherited from
[Config](Config.md).[middlewares](Config.md#middlewares)
#### Defined in
[packages/core/types/src/configuration.ts:256](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L256)
---
### no_proxy
• `Optional` **no_proxy**: `string`
#### Inherited from
[Config](Config.md).[no_proxy](Config.md#no_proxy)
#### Defined in
[packages/core/types/src/configuration.ts:252](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L252)
---
### notifications
• `Optional` **notifications**: [`Notifications`](Notifications.md)
#### Inherited from
[Config](Config.md).[notifications](Config.md#notifications)
#### Defined in
[packages/core/types/src/configuration.ts:254](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L254)
---
### notify
• `Optional` **notify**: [`Notifications`](Notifications.md) \| [`Notifications`](Notifications.md)[]
#### Inherited from
[Config](Config.md).[notify](Config.md#notify)
#### Defined in
[packages/core/types/src/configuration.ts:255](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L255)
---
### packages
• **packages**: [`PackageList`](PackageList.md)
#### Inherited from
[Config](Config.md).[packages](Config.md#packages)
#### Defined in
[packages/core/types/src/configuration.ts:283](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L283)
---
### plugins
• `Optional` **plugins**: `null` \| `string` \| `void`
#### Inherited from
[Config](Config.md).[plugins](Config.md#plugins)
#### Defined in
[packages/core/types/src/configuration.ts:250](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L250)
---
### publish
• `Optional` **publish**: [`PublishOptions`](PublishOptions.md)
#### Inherited from
[Config](Config.md).[publish](Config.md#publish)
#### Defined in
[packages/core/types/src/configuration.ts:244](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L244)
---
### secret
• **secret**: `string`
#### Inherited from
[Config](Config.md).[secret](Config.md#secret)
#### Defined in
[packages/core/types/src/configuration.ts:277](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L277)
---
### security
• **security**: [`Security`](Security.md)
#### Inherited from
[Config](Config.md).[security](Config.md#security)
#### Defined in
[packages/core/types/src/configuration.ts:285](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L285)
---
### self_path
• `Optional` **self_path**: `string`
#### Inherited from
[Config](Config.md).[self_path](Config.md#self_path)
#### Defined in
[packages/core/types/src/configuration.ts:281](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L281)
---
### server
• `Optional` **server**: [`ServerSettingsConf`](../modules.md#serversettingsconf)
#### Inherited from
[Config](Config.md).[server](Config.md#server)
#### Defined in
[packages/core/types/src/configuration.ts:259](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L259)
---
### server_id
• **server_id**: `string`
#### Inherited from
[Config](Config.md).[server_id](Config.md#server_id)
#### Defined in
[packages/core/types/src/configuration.ts:276](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L276)
---
### storage
• `Optional` **storage**: `string` \| `void`
#### Inherited from
[Config](Config.md).[storage](Config.md#storage)
#### Defined in
[packages/core/types/src/configuration.ts:235](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L235)
---
### store
• `Optional` **store**: `any`
#### Inherited from
[Config](Config.md).[store](Config.md#store)
#### Defined in
[packages/core/types/src/configuration.ts:245](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L245)
---
### uplinks
• **uplinks**: [`UpLinksConfList`](UpLinksConfList.md)
#### Inherited from
[Config](Config.md).[uplinks](Config.md#uplinks)
#### Defined in
[packages/core/types/src/configuration.ts:237](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L237)
---
### url_prefix
• `Optional` **url_prefix**: `string`
#### Inherited from
[Config](Config.md).[url_prefix](Config.md#url_prefix)
#### Defined in
[packages/core/types/src/configuration.ts:258](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L258)
---
### userRateLimit
• `Optional` **userRateLimit**: [`RateLimit`](../modules.md#ratelimit)
#### Inherited from
[Config](Config.md).[userRateLimit](Config.md#userratelimit)
#### Defined in
[packages/core/types/src/configuration.ts:263](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L263)
---
### user_agent
• `Optional` **user_agent**: `string`
#### Inherited from
[Config](Config.md).[user_agent](Config.md#user_agent)
#### Defined in
[packages/core/types/src/configuration.ts:248](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L248)
---
### web
• `Optional` **web**: [`WebConf`](../modules.md#webconf)
#### Inherited from
[Config](Config.md).[web](Config.md#web)
#### Defined in
[packages/core/types/src/configuration.ts:241](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L241)
## Methods
### checkSecretKey
▸ **checkSecretKey**(`token`): `string`
#### Parameters
| Name | Type |
| :------ | :------- |
| `token` | `string` |
#### Returns
`string`
#### Inherited from
[Config](Config.md).[checkSecretKey](Config.md#checksecretkey)
#### Defined in
[packages/core/types/src/configuration.ts:287](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L287)
---
### getMatchedPackagesSpec
▸ **getMatchedPackagesSpec**(`storage`): `void` \| [`PackageAccess`](PackageAccess.md)
#### Parameters
| Name | Type |
| :-------- | :------- |
| `storage` | `string` |
#### Returns
`void` \| [`PackageAccess`](PackageAccess.md)
#### Inherited from
[Config](Config.md).[getMatchedPackagesSpec](Config.md#getmatchedpackagesspec)
#### Defined in
[packages/core/types/src/configuration.ts:288](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L288)

315
website/versioned_docs/version-7.x/api/types/interfaces/ConfigYaml.md
View file

@ -1,315 +0,0 @@
---
id: 'ConfigYaml'
title: 'Interface: ConfigYaml'
sidebar_label: 'ConfigYaml'
sidebar_position: 0
custom_edit_url: null
---
YAML configuration file available options.
## Properties
### \_debug
• `Optional` **\_debug**: `boolean`
#### Defined in
[packages/core/types/src/configuration.ts:234](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L234)
---
### auth
• `Optional` **auth**: `any`
#### Defined in
[packages/core/types/src/configuration.ts:242](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L242)
---
### configPath
• `Optional` **configPath**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:266](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L266)
---
### experiments
• `Optional` **experiments**: [`FlagsConfig`](../modules.md#flagsconfig)
#### Defined in
[packages/core/types/src/configuration.ts:262](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L262)
---
### filters
• `Optional` **filters**: `any`
#### Defined in
[packages/core/types/src/configuration.ts:257](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L257)
---
### flags
• `Optional` **flags**: [`FlagsConfig`](../modules.md#flagsconfig)
#### Defined in
[packages/core/types/src/configuration.ts:260](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L260)
---
### http_proxy
• `Optional` **http_proxy**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:249](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L249)
---
### https
• `Optional` **https**: [`HttpsConf`](../modules.md#httpsconf)
#### Defined in
[packages/core/types/src/configuration.ts:247](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L247)
---
### https_proxy
• `Optional` **https_proxy**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:251](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L251)
---
### i18n
• `Optional` **i18n**: `Object`
#### Type declaration
| Name | Type |
| :---- | :------- |
| `web` | `string` |
#### Defined in
[packages/core/types/src/configuration.ts:267](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L267)
---
### listen
• `Optional` **listen**: [`ListenAddress`](ListenAddress.md)
#### Defined in
[packages/core/types/src/configuration.ts:246](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L246)
---
### log
• `Optional` **log**: [`LoggerConfItem`](LoggerConfItem.md)
#### Defined in
[packages/core/types/src/configuration.ts:238](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L238)
---
### logs
• `Optional` **logs**: [`LoggerConfItem`](LoggerConfItem.md)
#### Defined in
[packages/core/types/src/configuration.ts:240](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L240)
---
### max_body_size
• `Optional` **max_body_size**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:253](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L253)
---
### middlewares
• `Optional` **middlewares**: `any`
#### Defined in
[packages/core/types/src/configuration.ts:256](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L256)
---
### no_proxy
• `Optional` **no_proxy**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:252](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L252)
---
### notifications
• `Optional` **notifications**: [`Notifications`](Notifications.md)
#### Defined in
[packages/core/types/src/configuration.ts:254](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L254)
---
### notify
• `Optional` **notify**: [`Notifications`](Notifications.md) \| [`Notifications`](Notifications.md)[]
#### Defined in
[packages/core/types/src/configuration.ts:255](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L255)
---
### packages
• **packages**: [`PackageList`](PackageList.md)
#### Defined in
[packages/core/types/src/configuration.ts:236](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L236)
---
### plugins
• `Optional` **plugins**: `null` \| `string` \| `void`
#### Defined in
[packages/core/types/src/configuration.ts:250](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L250)
---
### publish
• `Optional` **publish**: [`PublishOptions`](PublishOptions.md)
#### Defined in
[packages/core/types/src/configuration.ts:244](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L244)
---
### security
• **security**: [`Security`](Security.md)
#### Defined in
[packages/core/types/src/configuration.ts:243](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L243)
---
### server
• `Optional` **server**: [`ServerSettingsConf`](../modules.md#serversettingsconf)
#### Defined in
[packages/core/types/src/configuration.ts:259](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L259)
---
### storage
• `Optional` **storage**: `string` \| `void`
#### Defined in
[packages/core/types/src/configuration.ts:235](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L235)
---
### store
• `Optional` **store**: `any`
#### Defined in
[packages/core/types/src/configuration.ts:245](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L245)
---
### uplinks
• **uplinks**: [`UpLinksConfList`](UpLinksConfList.md)
#### Defined in
[packages/core/types/src/configuration.ts:237](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L237)
---
### url_prefix
• `Optional` **url_prefix**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:258](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L258)
---
### userRateLimit
• `Optional` **userRateLimit**: [`RateLimit`](../modules.md#ratelimit)
#### Defined in
[packages/core/types/src/configuration.ts:263](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L263)
---
### user_agent
• `Optional` **user_agent**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:248](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L248)
---
### web
• `Optional` **web**: [`WebConf`](../modules.md#webconf)
#### Defined in
[packages/core/types/src/configuration.ts:241](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L241)

11
website/versioned_docs/version-7.x/api/types/interfaces/Dependencies.md
View file

@ -1,11 +0,0 @@
---
id: 'Dependencies'
title: 'Interface: Dependencies'
sidebar_label: 'Dependencies'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: `string`

77
website/versioned_docs/version-7.x/api/types/interfaces/Dist.md
View file

@ -1,77 +0,0 @@
---
id: 'Dist'
title: 'Interface: Dist'
sidebar_label: 'Dist'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### fileCount
• `Optional` **fileCount**: `number`
#### Defined in
[packages/core/types/src/manifest.ts:70](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L70)
---
### integrity
• `Optional` **integrity**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:71](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L71)
---
### npm-signature
• `Optional` **npm-signature**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:68](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L68)
---
### shasum
• **shasum**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:72](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L72)
---
### signatures
• `Optional` **signatures**: [`Signatures`](Signatures.md)[]
#### Defined in
[packages/core/types/src/manifest.ts:69](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L69)
---
### tarball
• **tarball**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:74](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L74)
---
### unpackedSize
• `Optional` **unpackedSize**: `number`
#### Defined in
[packages/core/types/src/manifest.ts:73](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L73)

37
website/versioned_docs/version-7.x/api/types/interfaces/DistFile.md
View file

@ -1,37 +0,0 @@
---
id: 'DistFile'
title: 'Interface: DistFile'
sidebar_label: 'DistFile'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### registry
• `Optional` **registry**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:20](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L20)
---
### sha
• **sha**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:19](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L19)
---
### url
• **url**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:18](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L18)

11
website/versioned_docs/version-7.x/api/types/interfaces/DistFiles.md
View file

@ -1,11 +0,0 @@
---
id: 'DistFiles'
title: 'Interface: DistFiles'
sidebar_label: 'DistFiles'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: [`DistFile`](DistFile.md)

11
website/versioned_docs/version-7.x/api/types/interfaces/Engines.md
View file

@ -1,11 +0,0 @@
---
id: 'Engines'
title: 'Interface: Engines'
sidebar_label: 'Engines'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: `string`

195
website/versioned_docs/version-7.x/api/types/interfaces/FullRemoteManifest.md
View file

@ -1,195 +0,0 @@
---
id: 'FullRemoteManifest'
title: 'Interface: FullRemoteManifest'
sidebar_label: 'FullRemoteManifest'
sidebar_position: 0
custom_edit_url: null
---
Represents upstream manifest from another registry
## Hierarchy
- **`FullRemoteManifest`**
↳ [`Manifest`](Manifest.md)
## Properties
### \_id
• `Optional` **\_id**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:174](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L174)
---
### \_rev
• `Optional` **\_rev**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:175](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L175)
---
### access
• `Optional` **access**: `any`
#### Defined in
[packages/core/types/src/manifest.ts:187](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L187)
---
### author
• `Optional` **author**: `string` \| [`Author`](Author.md)
#### Defined in
[packages/core/types/src/manifest.ts:193](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L193)
---
### bugs
• `Optional` **bugs**: `Object`
#### Type declaration
| Name | Type |
| :---- | :------- |
| `url` | `string` |
#### Defined in
[packages/core/types/src/manifest.ts:188](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L188)
---
### description
• `Optional` **description**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:177](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L177)
---
### dist-tags
• **dist-tags**: [`GenericBody`](GenericBody.md)
#### Defined in
[packages/core/types/src/manifest.ts:178](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L178)
---
### homepage
• `Optional` **homepage**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:190](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L190)
---
### keywords
• `Optional` **keywords**: `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:192](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L192)
---
### license
• `Optional` **license**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:189](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L189)
---
### maintainers
• `Optional` **maintainers**: [`Author`](Author.md)[]
#### Defined in
[packages/core/types/src/manifest.ts:181](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L181)
---
### name
• **name**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:176](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L176)
---
### readme
• `Optional` **readme**: `string`
store the latest readme \*
#### Defined in
[packages/core/types/src/manifest.ts:183](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L183)
---
### repository
• `Optional` **repository**: `string` \| { `directory?`: `string` ; `type?`: `string` ; `url`: `string` }
#### Defined in
[packages/core/types/src/manifest.ts:191](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L191)
---
### time
• **time**: [`GenericBody`](GenericBody.md)
#### Defined in
[packages/core/types/src/manifest.ts:179](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L179)
---
### users
• `Optional` **users**: [`PackageUsers`](PackageUsers.md)
store star assigned to this packages by users
#### Defined in
[packages/core/types/src/manifest.ts:185](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L185)
---
### versions
• **versions**: [`Versions`](Versions.md)
#### Defined in
[packages/core/types/src/manifest.ts:180](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L180)

11
website/versioned_docs/version-7.x/api/types/interfaces/GenericBody.md
View file

@ -1,11 +0,0 @@
---
id: 'GenericBody'
title: 'Interface: GenericBody'
sidebar_label: 'GenericBody'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: `string`

11
website/versioned_docs/version-7.x/api/types/interfaces/Headers.md
View file

@ -1,11 +0,0 @@
---
id: 'Headers'
title: 'Interface: Headers'
sidebar_label: 'Headers'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: `string`

117
website/versioned_docs/version-7.x/api/types/interfaces/HttpError.md
View file

@ -1,117 +0,0 @@
---
id: 'HttpError'
title: 'Interface: HttpError'
sidebar_label: 'HttpError'
sidebar_position: 0
custom_edit_url: null
---
## Hierarchy
- `Error`
↳ **`HttpError`**
## Indexable
▪ [key: `string`]: `any`
## Properties
### cause
• `Optional` **cause**: `unknown`
#### Inherited from
Error.cause
#### Defined in
node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/lib/lib.es2022.error.d.ts:26
---
### expose
• **expose**: `boolean`
#### Defined in
[packages/core/types/src/commons.ts:23](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/commons.ts#L23)
---
### headers
• `Optional` **headers**: `Object`
#### Index signature
▪ [key: `string`]: `string`
#### Defined in
[packages/core/types/src/commons.ts:24](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/commons.ts#L24)
---
### message
• **message**: `string`
#### Inherited from
Error.message
#### Defined in
node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/lib/lib.es5.d.ts:1054
---
### name
• **name**: `string`
#### Inherited from
Error.name
#### Defined in
node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/lib/lib.es5.d.ts:1053
---
### stack
• `Optional` **stack**: `string`
#### Inherited from
Error.stack
#### Defined in
node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/lib/lib.es5.d.ts:1055
---
### status
• **status**: `number`
#### Defined in
[packages/core/types/src/commons.ts:21](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/commons.ts#L21)
---
### statusCode
• **statusCode**: `number`
#### Defined in
[packages/core/types/src/commons.ts:22](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/commons.ts#L22)

37
website/versioned_docs/version-7.x/api/types/interfaces/HttpsConfKeyCert.md
View file

@ -1,37 +0,0 @@
---
id: 'HttpsConfKeyCert'
title: 'Interface: HttpsConfKeyCert'
sidebar_label: 'HttpsConfKeyCert'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### ca
• `Optional` **ca**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:193](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L193)
---
### cert
• **cert**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:192](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L192)
---
### key
• **key**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:191](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L191)

27
website/versioned_docs/version-7.x/api/types/interfaces/HttpsConfPfx.md
View file

@ -1,27 +0,0 @@
---
id: 'HttpsConfPfx'
title: 'Interface: HttpsConfPfx'
sidebar_label: 'HttpsConfPfx'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### passphrase
• `Optional` **passphrase**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:198](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L198)
---
### pfx
• **pfx**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:197](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L197)

75
website/versioned_docs/version-7.x/api/types/interfaces/ILocalStorage.md
View file

@ -1,75 +0,0 @@
---
id: 'ILocalStorage'
title: 'Interface: ILocalStorage'
sidebar_label: 'ILocalStorage'
sidebar_position: 0
custom_edit_url: null
---
## Methods
### add
▸ **add**(`name`): `void`
#### Parameters
| Name | Type |
| :----- | :------- |
| `name` | `string` |
#### Returns
`void`
#### Defined in
[packages/core/types/src/plugins/storage.ts:7](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/plugins/storage.ts#L7)
---
### get
▸ **get**(): [`StorageList`](../modules.md#storagelist)
#### Returns
[`StorageList`](../modules.md#storagelist)
#### Defined in
[packages/core/types/src/plugins/storage.ts:9](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/plugins/storage.ts#L9)
---
### remove
▸ **remove**(`name`): `void`
#### Parameters
| Name | Type |
| :----- | :------- |
| `name` | `string` |
#### Returns
`void`
#### Defined in
[packages/core/types/src/plugins/storage.ts:8](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/plugins/storage.ts#L8)
---
### sync
▸ **sync**(): `void`
#### Returns
`void`
#### Defined in
[packages/core/types/src/plugins/storage.ts:10](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/plugins/storage.ts#L10)

68
website/versioned_docs/version-7.x/api/types/interfaces/ITokenActions.md
View file

@ -1,68 +0,0 @@
---
id: 'ITokenActions'
title: 'Interface: ITokenActions'
sidebar_label: 'ITokenActions'
sidebar_position: 0
custom_edit_url: null
---
## Methods
### deleteToken
▸ **deleteToken**(`user`, `tokenKey`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :--------- | :------- |
| `user` | `string` |
| `tokenKey` | `string` |
#### Returns
`Promise`<`any`\>
#### Defined in
[packages/core/types/src/plugins/storage.ts:19](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/plugins/storage.ts#L19)
---
### readTokens
▸ **readTokens**(`filter`): `Promise`<[`Token`](Token.md)[]\>
#### Parameters
| Name | Type |
| :------- | :------------------------------ |
| `filter` | [`TokenFilter`](TokenFilter.md) |
#### Returns
`Promise`<[`Token`](Token.md)[]\>
#### Defined in
[packages/core/types/src/plugins/storage.ts:20](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/plugins/storage.ts#L20)
---
### saveToken
▸ **saveToken**(`token`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------------------ |
| `token` | [`Token`](Token.md) |
#### Returns
`Promise`<`any`\>
#### Defined in
[packages/core/types/src/plugins/storage.ts:18](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/plugins/storage.ts#L18)

27
website/versioned_docs/version-7.x/api/types/interfaces/JWTOptions.md
View file

@ -1,27 +0,0 @@
---
id: 'JWTOptions'
title: 'Interface: JWTOptions'
sidebar_label: 'JWTOptions'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### sign
• **sign**: [`JWTSignOptions`](JWTSignOptions.md)
#### Defined in
[packages/core/types/src/configuration.ts:149](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L149)
---
### verify
• **verify**: [`JWTVerifyOptions`](JWTVerifyOptions.md)
#### Defined in
[packages/core/types/src/configuration.ts:150](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L150)

67
website/versioned_docs/version-7.x/api/types/interfaces/JWTSignOptions.md
View file

@ -1,67 +0,0 @@
---
id: 'JWTSignOptions'
title: 'Interface: JWTSignOptions'
sidebar_label: 'JWTSignOptions'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### algorithm
• `Optional` **algorithm**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:154](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L154)
---
### clockTimestamp
• `Optional` **clockTimestamp**: `number`
#### Defined in
[packages/core/types/src/configuration.ts:159](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L159)
---
### expiresIn
• `Optional` **expiresIn**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:155](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L155)
---
### ignoreExpiration
• `Optional` **ignoreExpiration**: `boolean`
#### Defined in
[packages/core/types/src/configuration.ts:157](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L157)
---
### maxAge
• `Optional` **maxAge**: `string` \| `number`
#### Defined in
[packages/core/types/src/configuration.ts:158](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L158)
---
### notBefore
• `Optional` **notBefore**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:156](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L156)

67
website/versioned_docs/version-7.x/api/types/interfaces/JWTVerifyOptions.md
View file

@ -1,67 +0,0 @@
---
id: 'JWTVerifyOptions'
title: 'Interface: JWTVerifyOptions'
sidebar_label: 'JWTVerifyOptions'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### algorithm
• `Optional` **algorithm**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:163](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L163)
---
### clockTimestamp
• `Optional` **clockTimestamp**: `number`
#### Defined in
[packages/core/types/src/configuration.ts:168](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L168)
---
### expiresIn
• `Optional` **expiresIn**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:164](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L164)
---
### ignoreExpiration
• `Optional` **ignoreExpiration**: `boolean`
#### Defined in
[packages/core/types/src/configuration.ts:166](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L166)
---
### maxAge
• `Optional` **maxAge**: `string` \| `number`
#### Defined in
[packages/core/types/src/configuration.ts:167](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L167)
---
### notBefore
• `Optional` **notBefore**: `string` \| `number`
#### Defined in
[packages/core/types/src/configuration.ts:165](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L165)

11
website/versioned_docs/version-7.x/api/types/interfaces/ListenAddress.md
View file

@ -1,11 +0,0 @@
---
id: 'ListenAddress'
title: 'Interface: ListenAddress'
sidebar_label: 'ListenAddress'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: `string`

181
website/versioned_docs/version-7.x/api/types/interfaces/Logger.md
View file

@ -1,181 +0,0 @@
---
id: 'Logger'
title: 'Interface: Logger'
sidebar_label: 'Logger'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### child
• **child**: (`conf`: `any`) => `any`
#### Type declaration
▸ (`conf`): `any`
##### Parameters
| Name | Type |
| :----- | :---- |
| `conf` | `any` |
##### Returns
`any`
#### Defined in
[packages/core/types/src/configuration.ts:6](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L6)
---
### debug
• **debug**: (`conf`: `any`, `template?`: `string`) => `void`
#### Type declaration
▸ (`conf`, `template?`): `void`
##### Parameters
| Name | Type |
| :---------- | :------- |
| `conf` | `any` |
| `template?` | `string` |
##### Returns
`void`
#### Defined in
[packages/core/types/src/configuration.ts:7](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L7)
---
### error
• **error**: (`conf`: `any`, `template?`: `string`) => `void`
#### Type declaration
▸ (`conf`, `template?`): `void`
##### Parameters
| Name | Type |
| :---------- | :------- |
| `conf` | `any` |
| `template?` | `string` |
##### Returns
`void`
#### Defined in
[packages/core/types/src/configuration.ts:8](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L8)
---
### http
• **http**: (`conf`: `any`, `template?`: `string`) => `void`
#### Type declaration
▸ (`conf`, `template?`): `void`
##### Parameters
| Name | Type |
| :---------- | :------- |
| `conf` | `any` |
| `template?` | `string` |
##### Returns
`void`
#### Defined in
[packages/core/types/src/configuration.ts:9](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L9)
---
### info
• **info**: (`conf`: `any`, `template?`: `string`) => `void`
#### Type declaration
▸ (`conf`, `template?`): `void`
##### Parameters
| Name | Type |
| :---------- | :------- |
| `conf` | `any` |
| `template?` | `string` |
##### Returns
`void`
#### Defined in
[packages/core/types/src/configuration.ts:12](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L12)
---
### trace
• **trace**: (`conf`: `any`, `template?`: `string`) => `void`
#### Type declaration
▸ (`conf`, `template?`): `void`
##### Parameters
| Name | Type |
| :---------- | :------- |
| `conf` | `any` |
| `template?` | `string` |
##### Returns
`void`
#### Defined in
[packages/core/types/src/configuration.ts:10](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L10)
---
### warn
• **warn**: (`conf`: `any`, `template?`: `string`) => `void`
#### Type declaration
▸ (`conf`, `template?`): `void`
##### Parameters
| Name | Type |
| :---------- | :------- |
| `conf` | `any` |
| `template?` | `string` |
##### Returns
`void`
#### Defined in
[packages/core/types/src/configuration.ts:11](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L11)

37
website/versioned_docs/version-7.x/api/types/interfaces/LoggerConfItem.md
View file

@ -1,37 +0,0 @@
---
id: 'LoggerConfItem'
title: 'Interface: LoggerConfItem'
sidebar_label: 'LoggerConfItem'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### format
• **format**: [`LoggerFormat`](../modules.md#loggerformat)
#### Defined in
[packages/core/types/src/configuration.ts:42](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L42)
---
### level
• **level**: [`LoggerLevel`](../modules.md#loggerlevel)
#### Defined in
[packages/core/types/src/configuration.ts:43](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L43)
---
### type
• **type**: [`LoggerType`](../modules.md#loggertype)
#### Defined in
[packages/core/types/src/configuration.ts:41](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L41)

332
website/versioned_docs/version-7.x/api/types/interfaces/Manifest.md
View file

@ -1,332 +0,0 @@
---
id: 'Manifest'
title: 'Interface: Manifest'
sidebar_label: 'Manifest'
sidebar_position: 0
custom_edit_url: null
---
Represents upstream manifest from another registry
## Hierarchy
- [`FullRemoteManifest`](FullRemoteManifest.md)
- [`PublishManifest`](PublishManifest.md)
↳ **`Manifest`**
## Properties
### \_attachments
• **\_attachments**: [`AttachMents`](AttachMents.md)
The `_attachments` object has different usages:
- When a package is published, it contains the tarball as an string, this string is used to be
converted as a tarball, usually attached to the package but not stored in the database.
- If user runs `npm star` the \_attachments will be at the manifest body but empty.
It has also an internal usage:
- Used as a cache for the tarball, quick access to the tarball shasum, etc. Instead
iterate versions and find the right one, just using the tarball as a key which is what
the package manager sends to the registry.
- A `_attachments` object is added every time a private tarball is published, upstream cached tarballs are
not being part of this object, only for published private packages.
Note: This field is removed when the package is accesed through the web user interface.
#### Inherited from
[PublishManifest](PublishManifest.md).[\_attachments](PublishManifest.md#_attachments)
#### Defined in
[packages/core/types/src/manifest.ts:266](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L266)
---
### \_distfiles
• **\_distfiles**: [`DistFiles`](DistFiles.md)
store fast access to the dist url of an specific tarball, instead search version
by id, just the tarball id is faster.
The \_distfiles is created only when a package is being sync from an upstream.
also used to fetch tarballs from upstream, the private publish tarballs are not stored in
this object because they are not published in the upstream registry.
#### Defined in
[packages/core/types/src/manifest.ts:206](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L206)
---
### \_id
• `Optional` **\_id**: `string`
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[\_id](FullRemoteManifest.md#_id)
#### Defined in
[packages/core/types/src/manifest.ts:174](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L174)
---
### \_rev
• **\_rev**: `string`
store the revision of the manifest
#### Overrides
[FullRemoteManifest](FullRemoteManifest.md).[\_rev](FullRemoteManifest.md#_rev)
#### Defined in
[packages/core/types/src/manifest.ts:219](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L219)
---
### \_uplinks
• **\_uplinks**: [`UpLinks`](UpLinks.md)
Store access cache metadata, to avoid to fetch the same metadata multiple times.
The key represents the uplink id which is composed of a etag and a fetched timestamp.
The fetched timestamp is the time when the metadata was fetched, used to avoid to fetch the
same metadata until the metadata is older than the last fetch.
#### Defined in
[packages/core/types/src/manifest.ts:215](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L215)
---
### access
• `Optional` **access**: `any`
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[access](FullRemoteManifest.md#access)
#### Defined in
[packages/core/types/src/manifest.ts:187](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L187)
---
### author
• `Optional` **author**: `string` \| [`Author`](Author.md)
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[author](FullRemoteManifest.md#author)
#### Defined in
[packages/core/types/src/manifest.ts:193](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L193)
---
### bugs
• `Optional` **bugs**: `Object`
#### Type declaration
| Name | Type |
| :---- | :------- |
| `url` | `string` |
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[bugs](FullRemoteManifest.md#bugs)
#### Defined in
[packages/core/types/src/manifest.ts:188](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L188)
---
### description
• `Optional` **description**: `string`
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[description](FullRemoteManifest.md#description)
#### Defined in
[packages/core/types/src/manifest.ts:177](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L177)
---
### dist-tags
• **dist-tags**: [`GenericBody`](GenericBody.md)
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[dist-tags](FullRemoteManifest.md#dist-tags)
#### Defined in
[packages/core/types/src/manifest.ts:178](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L178)
---
### homepage
• `Optional` **homepage**: `string`
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[homepage](FullRemoteManifest.md#homepage)
#### Defined in
[packages/core/types/src/manifest.ts:190](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L190)
---
### keywords
• `Optional` **keywords**: `string`[]
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[keywords](FullRemoteManifest.md#keywords)
#### Defined in
[packages/core/types/src/manifest.ts:192](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L192)
---
### license
• `Optional` **license**: `string`
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[license](FullRemoteManifest.md#license)
#### Defined in
[packages/core/types/src/manifest.ts:189](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L189)
---
### maintainers
• `Optional` **maintainers**: [`Author`](Author.md)[]
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[maintainers](FullRemoteManifest.md#maintainers)
#### Defined in
[packages/core/types/src/manifest.ts:181](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L181)
---
### name
• **name**: `string`
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[name](FullRemoteManifest.md#name)
#### Defined in
[packages/core/types/src/manifest.ts:176](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L176)
---
### readme
• `Optional` **readme**: `string`
store the latest readme \*
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[readme](FullRemoteManifest.md#readme)
#### Defined in
[packages/core/types/src/manifest.ts:183](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L183)
---
### repository
• `Optional` **repository**: `string` \| { `directory?`: `string` ; `type?`: `string` ; `url`: `string` }
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[repository](FullRemoteManifest.md#repository)
#### Defined in
[packages/core/types/src/manifest.ts:191](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L191)
---
### time
• **time**: [`GenericBody`](GenericBody.md)
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[time](FullRemoteManifest.md#time)
#### Defined in
[packages/core/types/src/manifest.ts:179](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L179)
---
### users
• `Optional` **users**: [`PackageUsers`](PackageUsers.md)
store star assigned to this packages by users
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[users](FullRemoteManifest.md#users)
#### Defined in
[packages/core/types/src/manifest.ts:185](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L185)
---
### versions
• **versions**: [`Versions`](Versions.md)
#### Inherited from
[FullRemoteManifest](FullRemoteManifest.md).[versions](FullRemoteManifest.md#versions)
#### Defined in
[packages/core/types/src/manifest.ts:180](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L180)

11
website/versioned_docs/version-7.x/api/types/interfaces/MergeTags.md
View file

@ -1,11 +0,0 @@
---
id: 'MergeTags'
title: 'Interface: MergeTags'
sidebar_label: 'MergeTags'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: `string`

67
website/versioned_docs/version-7.x/api/types/interfaces/Notifications.md
View file

@ -1,67 +0,0 @@
---
id: 'Notifications'
title: 'Interface: Notifications'
sidebar_label: 'Notifications'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### content
• **content**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:208](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L208)
---
### endpoint
• **endpoint**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:207](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L207)
---
### headers
• **headers**: [`Headers`](Headers.md)
#### Defined in
[packages/core/types/src/configuration.ts:209](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L209)
---
### method
• **method**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:204](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L204)
---
### packagePattern
• **packagePattern**: `RegExp`
#### Defined in
[packages/core/types/src/configuration.ts:205](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L205)
---
### packagePatternFlags
• **packagePatternFlags**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:206](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L206)

121
website/versioned_docs/version-7.x/api/types/interfaces/Package.md
View file

@ -1,121 +0,0 @@
---
id: 'Package'
title: 'Interface: Package'
sidebar_label: 'Package'
sidebar_position: 0
custom_edit_url: null
---
**`Deprecated`**
use Manifest instead
## Properties
### \_attachments
• **\_attachments**: [`AttachMents`](AttachMents.md)
#### Defined in
[packages/core/types/src/manifest.ts:165](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L165)
---
### \_distfiles
• **\_distfiles**: [`DistFiles`](DistFiles.md)
#### Defined in
[packages/core/types/src/manifest.ts:164](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L164)
---
### \_id
• `Optional` **\_id**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:157](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L157)
---
### \_rev
• **\_rev**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:167](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L167)
---
### \_uplinks
• **\_uplinks**: [`UpLinks`](UpLinks.md)
#### Defined in
[packages/core/types/src/manifest.ts:166](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L166)
---
### dist-tags
• **dist-tags**: [`GenericBody`](GenericBody.md)
#### Defined in
[packages/core/types/src/manifest.ts:160](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L160)
---
### name
• **name**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:158](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L158)
---
### readme
• `Optional` **readme**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:162](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L162)
---
### time
• **time**: [`GenericBody`](GenericBody.md)
#### Defined in
[packages/core/types/src/manifest.ts:161](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L161)
---
### users
• `Optional` **users**: [`PackageUsers`](PackageUsers.md)
#### Defined in
[packages/core/types/src/manifest.ts:163](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L163)
---
### versions
• **versions**: [`Versions`](Versions.md)
#### Defined in
[packages/core/types/src/manifest.ts:159](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L159)

63
website/versioned_docs/version-7.x/api/types/interfaces/PackageAccess.md
View file

@ -1,63 +0,0 @@
---
id: 'PackageAccess'
title: 'Interface: PackageAccess'
sidebar_label: 'PackageAccess'
sidebar_position: 0
custom_edit_url: null
---
## Hierarchy
- **`PackageAccess`**
↳ [`AuthPackageAllow`](AuthPackageAllow.md)
## Properties
### access
• `Optional` **access**: `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:5](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L5)
---
### proxy
• `Optional` **proxy**: `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:4](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L4)
---
### publish
• `Optional` **publish**: `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:3](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L3)
---
### storage
• `Optional` **storage**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:2](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L2)
---
### unpublish
• **unpublish**: `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:6](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L6)

57
website/versioned_docs/version-7.x/api/types/interfaces/PackageAccessYaml.md
View file

@ -1,57 +0,0 @@
---
id: 'PackageAccessYaml'
title: 'Interface: PackageAccessYaml'
sidebar_label: 'PackageAccessYaml'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### access
• `Optional` **access**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:36](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L36)
---
### proxy
• `Optional` **proxy**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:35](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L35)
---
### publish
• `Optional` **publish**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:34](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L34)
---
### storage
• `Optional` **storage**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:33](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L33)
---
### unpublish
• `Optional` **unpublish**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:37](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L37)

11
website/versioned_docs/version-7.x/api/types/interfaces/PackageList.md
View file

@ -1,11 +0,0 @@
---
id: 'PackageList'
title: 'Interface: PackageList'
sidebar_label: 'PackageList'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: [`PackageAccess`](PackageAccess.md)

11
website/versioned_docs/version-7.x/api/types/interfaces/PackageUsers.md
View file

@ -1,11 +0,0 @@
---
id: 'PackageUsers'
title: 'Interface: PackageUsers'
sidebar_label: 'PackageUsers'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: `boolean`

11
website/versioned_docs/version-7.x/api/types/interfaces/PeerDependenciesMeta.md
View file

@ -1,11 +0,0 @@
---
id: 'PeerDependenciesMeta'
title: 'Interface: PeerDependenciesMeta'
sidebar_label: 'PeerDependenciesMeta'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [dependencyName: `string`]: { `optional?`: `boolean` }

40
website/versioned_docs/version-7.x/api/types/interfaces/PublishManifest.md
View file

@ -1,40 +0,0 @@
---
id: 'PublishManifest'
title: 'Interface: PublishManifest'
sidebar_label: 'PublishManifest'
sidebar_position: 0
custom_edit_url: null
---
## Hierarchy
- **`PublishManifest`**
↳ [`Manifest`](Manifest.md)
## Properties
### \_attachments
• **\_attachments**: [`AttachMents`](AttachMents.md)
The `_attachments` object has different usages:
- When a package is published, it contains the tarball as an string, this string is used to be
converted as a tarball, usually attached to the package but not stored in the database.
- If user runs `npm star` the \_attachments will be at the manifest body but empty.
It has also an internal usage:
- Used as a cache for the tarball, quick access to the tarball shasum, etc. Instead
iterate versions and find the right one, just using the tarball as a key which is what
the package manager sends to the registry.
- A `_attachments` object is added every time a private tarball is published, upstream cached tarballs are
not being part of this object, only for published private packages.
Note: This field is removed when the package is accesed through the web user interface.
#### Defined in
[packages/core/types/src/manifest.ts:266](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L266)

17
website/versioned_docs/version-7.x/api/types/interfaces/PublishOptions.md
View file

@ -1,17 +0,0 @@
---
id: 'PublishOptions'
title: 'Interface: PublishOptions'
sidebar_label: 'PublishOptions'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### allow_offline
• **allow_offline**: `boolean`
#### Defined in
[packages/core/types/src/configuration.ts:183](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L183)

47
website/versioned_docs/version-7.x/api/types/interfaces/RemoteUser.md
View file

@ -1,47 +0,0 @@
---
id: 'RemoteUser'
title: 'Interface: RemoteUser'
sidebar_label: 'RemoteUser'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### error
• `Optional` **error**: `string`
#### Defined in
[packages/core/types/src/commons.ts:12](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/commons.ts#L12)
---
### groups
• **groups**: `string`[]
#### Defined in
[packages/core/types/src/commons.ts:10](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/commons.ts#L10)
---
### name
• **name**: `string` \| `void`
#### Defined in
[packages/core/types/src/commons.ts:11](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/commons.ts#L11)
---
### real_groups
• **real_groups**: `string`[]
#### Defined in
[packages/core/types/src/commons.ts:9](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/commons.ts#L9)

37
website/versioned_docs/version-7.x/api/types/interfaces/Security.md
View file

@ -1,37 +0,0 @@
---
id: 'Security'
title: 'Interface: Security'
sidebar_label: 'Security'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### api
• **api**: [`APITokenOptions`](APITokenOptions.md)
#### Defined in
[packages/core/types/src/configuration.ts:179](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L179)
---
### enhancedLegacySignature
• `Optional` **enhancedLegacySignature**: `boolean`
#### Defined in
[packages/core/types/src/configuration.ts:177](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L177)
---
### web
• **web**: [`JWTOptions`](JWTOptions.md)
#### Defined in
[packages/core/types/src/configuration.ts:178](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L178)

27
website/versioned_docs/version-7.x/api/types/interfaces/Signatures.md
View file

@ -1,27 +0,0 @@
---
id: 'Signatures'
title: 'Interface: Signatures'
sidebar_label: 'Signatures'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### keyid
• **keyid**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:63](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L63)
---
### sig
• **sig**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:64](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L64)

11
website/versioned_docs/version-7.x/api/types/interfaces/Tags.md
View file

@ -1,11 +0,0 @@
---
id: 'Tags'
title: 'Interface: Tags'
sidebar_label: 'Tags'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: [`Version`](Version.md)

77
website/versioned_docs/version-7.x/api/types/interfaces/Token.md
View file

@ -1,77 +0,0 @@
---
id: 'Token'
title: 'Interface: Token'
sidebar_label: 'Token'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### cidr
• `Optional` **cidr**: `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:31](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L31)
---
### created
• **created**: `string` \| `number`
#### Defined in
[packages/core/types/src/manifest.ts:33](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L33)
---
### key
• **key**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:30](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L30)
---
### readonly
• **readonly**: `boolean`
#### Defined in
[packages/core/types/src/manifest.ts:32](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L32)
---
### token
• **token**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:29](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L29)
---
### updated
• `Optional` **updated**: `string` \| `number`
#### Defined in
[packages/core/types/src/manifest.ts:34](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L34)
---
### user
• **user**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:28](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L28)

17
website/versioned_docs/version-7.x/api/types/interfaces/TokenFilter.md
View file

@ -1,17 +0,0 @@
---
id: 'TokenFilter'
title: 'Interface: TokenFilter'
sidebar_label: 'TokenFilter'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### user
• **user**: `string`
#### Defined in
[packages/core/types/src/plugins/storage.ts:14](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/plugins/storage.ts#L14)

117
website/versioned_docs/version-7.x/api/types/interfaces/UpLinkConf.md
View file

@ -1,117 +0,0 @@
---
id: 'UpLinkConf'
title: 'Interface: UpLinkConf'
sidebar_label: 'UpLinkConf'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### \_autogenerated
• `Optional` **\_autogenerated**: `boolean`
#### Defined in
[packages/core/types/src/configuration.ts:67](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L67)
---
### auth
• `Optional` **auth**: [`UpLinkTokenConf`](UpLinkTokenConf.md)
#### Defined in
[packages/core/types/src/configuration.ts:65](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L65)
---
### ca
• `Optional` **ca**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:58](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L58)
---
### cache
• `Optional` **cache**: `boolean`
#### Defined in
[packages/core/types/src/configuration.ts:59](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L59)
---
### fail_timeout
• `Optional` **fail_timeout**: `string` \| `void`
#### Defined in
[packages/core/types/src/configuration.ts:63](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L63)
---
### headers
• `Optional` **headers**: [`Headers`](Headers.md)
#### Defined in
[packages/core/types/src/configuration.ts:64](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L64)
---
### max_fails
• `Optional` **max_fails**: `number` \| `void`
#### Defined in
[packages/core/types/src/configuration.ts:62](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L62)
---
### maxage
• `Optional` **maxage**: `string` \| `void`
#### Defined in
[packages/core/types/src/configuration.ts:61](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L61)
---
### strict_ssl
• `Optional` **strict_ssl**: `boolean` \| `void`
#### Defined in
[packages/core/types/src/configuration.ts:66](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L66)
---
### timeout
• `Optional` **timeout**: `string` \| `void`
#### Defined in
[packages/core/types/src/configuration.ts:60](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L60)
---
### url
• **url**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:57](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L57)

27
website/versioned_docs/version-7.x/api/types/interfaces/UpLinkMetadata.md
View file

@ -1,27 +0,0 @@
---
id: 'UpLinkMetadata'
title: 'Interface: UpLinkMetadata'
sidebar_label: 'UpLinkMetadata'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### etag
• **etag**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:54](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L54)
---
### fetched
• **fetched**: `number`
#### Defined in
[packages/core/types/src/manifest.ts:55](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L55)

37
website/versioned_docs/version-7.x/api/types/interfaces/UpLinkTokenConf.md
View file

@ -1,37 +0,0 @@
---
id: 'UpLinkTokenConf'
title: 'Interface: UpLinkTokenConf'
sidebar_label: 'UpLinkTokenConf'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### token
• `Optional` **token**: `string`
#### Defined in
[packages/core/types/src/configuration.ts:52](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L52)
---
### token_env
• `Optional` **token_env**: `string` \| `boolean`
#### Defined in
[packages/core/types/src/configuration.ts:53](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L53)
---
### type
• **type**: [`TypeToken`](../modules.md#typetoken)
#### Defined in
[packages/core/types/src/configuration.ts:51](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/configuration.ts#L51)

11
website/versioned_docs/version-7.x/api/types/interfaces/UpLinks.md
View file

@ -1,11 +0,0 @@
---
id: 'UpLinks'
title: 'Interface: UpLinks'
sidebar_label: 'UpLinks'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: [`UpLinkMetadata`](UpLinkMetadata.md)

11
website/versioned_docs/version-7.x/api/types/interfaces/UpLinksConfList.md
View file

@ -1,11 +0,0 @@
---
id: 'UpLinksConfList'
title: 'Interface: UpLinksConfList'
sidebar_label: 'UpLinksConfList'
sidebar_position: 0
custom_edit_url: null
---
## Indexable
▪ [key: `string`]: [`UpLinkConf`](UpLinkConf.md)

414
website/versioned_docs/version-7.x/api/types/interfaces/Version.md
View file

@ -1,414 +0,0 @@
---
id: 'Version'
title: 'Interface: Version'
sidebar_label: 'Version'
sidebar_position: 0
custom_edit_url: null
---
## Properties
### \_hasShrinkwrap
• `Optional` **\_hasShrinkwrap**: `boolean`
#### Defined in
[packages/core/types/src/manifest.ts:132](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L132)
---
### \_id
• **\_id**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:129](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L129)
---
### \_npmUser
• **\_npmUser**: [`Author`](Author.md)
#### Defined in
[packages/core/types/src/manifest.ts:131](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L131)
---
### \_npmVersion
• `Optional` **\_npmVersion**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:130](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L130)
---
### author
• **author**: `string` \| [`Author`](Author.md)
#### Defined in
[packages/core/types/src/manifest.ts:103](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L103)
---
### bin
• `Optional` **bin**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:111](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L111)
---
### bugs
• `Optional` **bugs**: `any`
#### Defined in
[packages/core/types/src/manifest.ts:112](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L112)
---
### bundleDependencies
• `Optional` **bundleDependencies**: [`Dependencies`](Dependencies.md)
#### Defined in
[packages/core/types/src/manifest.ts:126](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L126)
---
### contributors
• `Optional` **contributors**: [`Author`](Author.md)[]
#### Defined in
[packages/core/types/src/manifest.ts:116](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L116)
---
### cpu
• `Optional` **cpu**: `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:137](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L137)
---
### dependencies
• `Optional` **dependencies**: [`Dependencies`](Dependencies.md)
#### Defined in
[packages/core/types/src/manifest.ts:121](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L121)
---
### deprecated
• `Optional` **deprecated**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:133](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L133)
---
### description
• **description**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:110](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L110)
---
### devDependencies
• `Optional` **devDependencies**: [`Dependencies`](Dependencies.md)
#### Defined in
[packages/core/types/src/manifest.ts:123](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L123)
---
### directories
• `Optional` **directories**: `any`
#### Defined in
[packages/core/types/src/manifest.ts:101](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L101)
---
### dist
• **dist**: [`Dist`](Dist.md)
#### Defined in
[packages/core/types/src/manifest.ts:102](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L102)
---
### engines
• `Optional` **engines**: [`Engines`](Engines.md)
#### Defined in
[packages/core/types/src/manifest.ts:135](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L135)
---
### etag
• `Optional` **etag**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:120](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L120)
---
### files
• `Optional` **files**: `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:113](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L113)
---
### funding
• `Optional` **funding**: `Object`
#### Type declaration
| Name | Type |
| :----- | :------- |
| `type` | `string` |
| `url` | `string` |
#### Defined in
[packages/core/types/src/manifest.ts:134](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L134)
---
### gitHead
• `Optional` **gitHead**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:114](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L114)
---
### hasInstallScript
• `Optional` **hasInstallScript**: `boolean`
#### Defined in
[packages/core/types/src/manifest.ts:136](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L136)
---
### homemage
• `Optional` **homemage**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:105](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L105)
---
### homepage
• `Optional` **homepage**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:119](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L119)
---
### keywords
• `Optional` **keywords**: `string` \| `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:127](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L127)
---
### license
• `Optional` **license**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:106](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L106)
---
### main
• **main**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:104](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L104)
---
### maintainers
• `Optional` **maintainers**: [`Author`](Author.md)[]
#### Defined in
[packages/core/types/src/manifest.ts:115](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L115)
---
### name
• **name**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:99](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L99)
---
### nodeVersion
• `Optional` **nodeVersion**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:128](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L128)
---
### optionalDependencies
• `Optional` **optionalDependencies**: [`Dependencies`](Dependencies.md)
#### Defined in
[packages/core/types/src/manifest.ts:124](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L124)
---
### os
• `Optional` **os**: `string`[]
#### Defined in
[packages/core/types/src/manifest.ts:138](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L138)
---
### peerDependencies
• `Optional` **peerDependencies**: [`Dependencies`](Dependencies.md)
#### Defined in
[packages/core/types/src/manifest.ts:122](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L122)
---
### peerDependenciesMeta
• `Optional` **peerDependenciesMeta**: [`PeerDependenciesMeta`](PeerDependenciesMeta.md)
#### Defined in
[packages/core/types/src/manifest.ts:125](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L125)
---
### readme
• **readme**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:107](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L107)
---
### readmeFileName
• `Optional` **readmeFileName**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:108](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L108)
---
### readmeFilename
• `Optional` **readmeFilename**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:109](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L109)
---
### repository
• `Optional` **repository**: `any`
#### Defined in
[packages/core/types/src/manifest.ts:117](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L117)
---
### scripts
• `Optional` **scripts**: `any`
#### Defined in
[packages/core/types/src/manifest.ts:118](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L118)
---
### version
• **version**: `string`
#### Defined in
[packages/core/types/src/manifest.ts:100](https://github.com/verdaccio/verdaccio/blob/10057a4ff/packages/core/types/src/manifest.ts#L100)

Some files were not shown because too many files have changed in this diff Show more