@verdaccio/core

---

Interface: Storage<PluginConfig>

Alpha

The base plugin class, set of utilities for developing plugins.

Extends

• Plugin<PluginConfig>

Type Parameters

Type Parameter
PluginConfig

Properties

Property	Modifier	Type	Description	Inherited from
config	readonly	unknown	Alpha	Plugin.config
options	readonly	PluginOptions	Alpha	Plugin.options
version	readonly	number	Alpha	Plugin.version

Methods

add()

add(name): Promise<void>;

Parameters

Parameter	Type
name	string

Returns

Promise<void>

---

deleteToken()

deleteToken(user, tokenKey): Promise<any>;

Parameters

Parameter	Type
user	string
tokenKey	string

Returns

Promise<any>

---

get()

get(): Promise<any>;

Returns

Promise<any>

---

getPackageStorage()

getPackageStorage(packageInfo): StorageHandler;

Parameters

Parameter	Type
packageInfo	string

Returns

StorageHandler

---

getSecret()

getSecret(): Promise<string>;

Returns

Promise<string>

---

getVersion()

getVersion(): number;

Alpha

Returns

number

Inherited from

Plugin.getVersion

---

init()

init(): Promise<void>;

Returns

Promise<void>

---

readTokens()

readTokens(filter): Promise<Token[]>;

Parameters

Parameter	Type
filter	TokenFilter

Returns

Promise<Token[]>

---

remove()

remove(name): Promise<void>;

Parameters

Parameter	Type
name	string

Returns

Promise<void>

---

saveToken()

saveToken(token): Promise<any>;

Parameters

Parameter	Type
token	Token

Returns

Promise<any>

---

search()

search(query): Promise<SearchItem[]>;

Parameters

Parameter	Type
query	SearchQuery

Returns

Promise<SearchItem[]>

---

setSecret()

setSecret(secret): Promise<any>;

Parameters

Parameter	Type
secret	string

Returns

Promise<any>