@verdaccio/types - v13.0.0-next-8.2

Interfaces

• APITokenOptions
• AbbreviatedVersions
• AllowAccess
• AttachMents
• AttachMentsItem
• AuthHtpasswd
• AuthPackageAllow
• Author
• Config
• ConfigWithHttps
• ConfigYaml
• Dependencies
• Dist
• DistFile
• DistFiles
• Engines
• FullRemoteManifest
• GenericBody
• Headers
• HttpError
• HttpsConfKeyCert
• HttpsConfPfx
• ILocalStorage
• ITokenActions
• JWTOptions
• JWTSignOptions
• JWTVerifyOptions
• ListenAddress
• Logger
• LoggerConfItem
• Manifest
• MergeTags
• Notifications
• Package
• PackageAccess
• PackageAccessYaml
• PackageList
• PackageUsers
• PeerDependenciesMeta
• PublishManifest
• PublishOptions
• RemoteUser
• Security
• Signatures
• Tags
• Token
• TokenFilter
• UpLinkConf
• UpLinkMetadata
• UpLinkTokenConf
• UpLinks
• UpLinksConfList
• Version
• Versions

Type Aliases

AbbreviatedManifest

Ƭ AbbreviatedManifest: Pick<Manifest, "name" | "dist-tags" | "time"> & { modified: string ; versions: AbbreviatedVersions }

Defined in

packages/core/types/src/manifest.ts:253

---

AbbreviatedVersion

Ƭ AbbreviatedVersion: Pick<Version, "name" | "version" | "dependencies" | "devDependencies" | "bin" | "dist" | "engines" | "funding" | "peerDependencies" | "cpu" | "deprecated" | "directories" | "hasInstallScript" | "optionalDependencies" | "os" | "peerDependenciesMeta" | "acceptDependencies" | "_hasShrinkwrap">

Defined in

packages/core/types/src/manifest.ts:225

---

AgentOptionsConf

Ƭ AgentOptionsConf: HttpAgentOptions | HttpsAgentOptions

Defined in

packages/core/types/src/configuration.ts:53

---

Algorithm

Ƭ Algorithm: "HS256" | "HS384" | "HS512" | "RS256" | "RS384" | "RS512" | "ES256" | "ES384" | "ES512" | "PS256" | "PS384" | "PS512" | "none"

Defined in

packages/core/types/src/configuration.ts:162

---

AuthConf

Ƭ AuthConf: any | AuthHtpasswd

Defined in

packages/core/types/src/configuration.ts:155

---

Callback

Ƭ Callback: Function

Defined in

packages/core/types/src/commons.ts:2

---

CallbackAction

Ƭ CallbackAction: (err: any | null) => void

Type declaration

▸ (err): void

Parameters

Name	Type
err	any | null

Returns

void

Defined in

packages/core/types/src/commons.ts:4

---

CallbackError

Ƭ CallbackError: (err: NodeJS.ErrnoException) => void

Type declaration

▸ (err): void

Parameters

Name	Type
err	NodeJS.ErrnoException

Returns

void

Defined in

packages/core/types/src/commons.ts:6

---

CommonWebConf

Ƭ CommonWebConf: Object

Type declaration

Name	Type
darkMode?	boolean
favicon?	string
gravatar?	boolean
hideDeprecatedVersions?	boolean
language?	string
login?	boolean
logo?	string
logoDark?	string
pkgManagers?	PackageManagers[]
primaryColor	string
scope?	string
showDownloadTarball?	boolean
showFooter?	boolean
showInfo?	boolean
showRaw?	boolean
showSearch?	boolean
showSettings?	boolean
showThemeSwitch?	boolean
showUplinks?	boolean
sort_packages?	string
title?	string
url_prefix?	string

Defined in

packages/core/types/src/configuration.ts:89

---

FlagsConfig

Ƭ FlagsConfig: Object

Type declaration

Name	Type
changePassword?	boolean
searchRemote?	boolean

Defined in

packages/core/types/src/configuration.ts:81

---

HttpsConf

Ƭ HttpsConf: HttpsConfKeyCert | HttpsConfPfx

Defined in

packages/core/types/src/configuration.ts:228

---

LoggerConfigItem

Ƭ LoggerConfigItem: Object

Type declaration

Name	Type
async?	boolean
colors?	boolean
format?	LoggerFormat
level?	LoggerLevel
path?	string
type?	LoggerType

Defined in

packages/core/types/src/configuration.ts:22

---

LoggerFormat

Ƭ LoggerFormat: "pretty" | "pretty-timestamped" | "json"

Defined in

packages/core/types/src/configuration.ts:19

---

LoggerLevel

Ƭ LoggerLevel: "fatal" | "error" | "warn" | "info" | "http" | "debug" | "trace"

Defined in

packages/core/types/src/configuration.ts:20

---

LoggerType

Ƭ LoggerType: "stdout" | "file"

Defined in

packages/core/types/src/configuration.ts:18

---

Notification

Ƭ Notification: Notifications

Defined in

packages/core/types/src/configuration.ts:239

---

PackageManagers

Ƭ PackageManagers: "pnpm" | "yarn" | "npm"

Defined in

packages/core/types/src/configuration.ts:86

---

PackageTransformer

Ƭ PackageTransformer: (pkg: Manifest) => Manifest

Type declaration

▸ (pkg): Manifest

Parameters

Name	Type
pkg	Manifest

Returns

Manifest

Defined in

packages/core/types/src/plugins/storage.ts:45

---

PublisherMaintainer

Ƭ PublisherMaintainer: Object

Type declaration

Name	Type
email	string
username	string

Defined in

packages/core/types/src/search.ts:1

---

RateLimit

Ƭ RateLimit: Object

Type declaration

Name	Type
max?	number
windowMs?	number

Defined in

packages/core/types/src/configuration.ts:76

---

ReadPackageCallback

Ƭ ReadPackageCallback: (err: any | null, data?: Manifest) => void

Type declaration

▸ (err, data?): void

Parameters

Name	Type
err	any | null
data?	Manifest

Returns

void

Defined in

packages/core/types/src/plugins/storage.ts:46

---

ReadmeOptions

Ƭ ReadmeOptions: "latest" | "tagged" | "all" | undefined

Defined in

packages/core/types/src/configuration.ts:205

---

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

packages/core/types/src/search.ts:6

---

SearchResultWeb

Ƭ SearchResultWeb: Object

Type declaration

Name	Type
description	string
name	string
version	string

Defined in

packages/core/types/src/search.ts:24

---

ServerSettingsConf

Ƭ ServerSettingsConf: Object

Type declaration

Name	Type	Description
keepAliveTimeout?	number	-
passwordValidationRegex?	RegExp	-
pluginPrefix?	string	Plugins should be prefixed verdaccio-XXXXXX by default. To override the default prefix, use this property without - If you set pluginPrefix: acme, the packages to resolve will be acme-XXXXXX
rateLimit	RateLimit	-
trustProxy?	string	-

Defined in

packages/core/types/src/configuration.ts:241

---

StorageList

Ƭ StorageList: string[]

Defined in

packages/core/types/src/plugins/storage.ts:4

---

StorageUpdateCallback

Ƭ StorageUpdateCallback: (data: Manifest, cb: CallbackAction) => void

Type declaration

▸ (data, cb): void

Parameters

Name	Type
data	Manifest
cb	CallbackAction

Returns

void

Defined in

packages/core/types/src/plugins/storage.ts:42

---

StorageWriteCallback

Ƭ StorageWriteCallback: (name: string, json: Manifest, callback: Callback) => void

Type declaration

▸ (name, json, callback): void

Parameters

Name	Type
name	string
json	Manifest
callback	Callback

Returns

void

Defined in

packages/core/types/src/plugins/storage.ts:44

---

StringValue

Ƭ StringValue: string | void | null

Defined in

packages/core/types/src/commons.ts:15

---

TemplateUIOptions

Ƭ TemplateUIOptions: { base: string ; basename?: string ; flags: FlagsConfig ; host?: string ; protocol?: string ; uri?: string ; version?: string } & CommonWebConf

Options are passed to the index.html

Defined in

packages/core/types/src/configuration.ts:117

---

TypeToken

Ƭ TypeToken: "Bearer" | "Basic"

Defined in

packages/core/types/src/configuration.ts:6

---

URLPrefix

Ƭ URLPrefix: Object

Type declaration

Name	Type
absolute	boolean
basePath	string

Defined in

packages/core/types/src/commons.ts:30

---

UnPublishManifest

Ƭ UnPublishManifest: Omit<Manifest, "_attachments" | "_distfiles" | "_uplinks">

Defined in

packages/core/types/src/manifest.ts:261

---

WebConf

Ƭ WebConf: { bodyAfter?: string[] ; bodyBefore?: string[] ; enable?: boolean ; html_cache?: boolean ; metaScripts?: string[] ; primaryColor?: string ; primary_color?: string ; rateLimit?: RateLimit ; scriptsBodyAfter?: string[] ; scriptsHead?: string[] ; scriptsbodyBefore?: string[] } & CommonWebConf

Options on config.yaml for web

Defined in

packages/core/types/src/configuration.ts:131

---

onEndSearchPackage

Ƭ onEndSearchPackage: (error?: any) => void

Type declaration

▸ (error?): void

Parameters

Name	Type
error?	any

Returns

void

Defined in

packages/core/types/src/plugins/storage.ts:39

---

onSearchPackage

Ƭ onSearchPackage: (item: Manifest, cb: CallbackAction) => void

Type declaration

▸ (item, cb): void

This method expect return a Package object eg: { name: string; time: number; ... and other props }

The cb callback object will be executed if:

• it might return object (truly)
• it might reutrn null

Parameters

Name	Type
item	Manifest
cb	CallbackAction

Returns

void

Defined in

packages/core/types/src/plugins/storage.ts:36

---

onValidatePackage

Ƭ onValidatePackage: (name: string) => boolean

Type declaration

▸ (name): boolean

Parameters

Name	Type
name	string

Returns

boolean

Defined in

packages/core/types/src/plugins/storage.ts:40