Interface: StorageHandler
pluginUtils.StorageHandler
Storage Handler
Used in storage plugin for managing packages and tarballs.
Properties
logger
• logger: Logger
Defined in
Methods
createPackage
▸ createPackage(packageName
, manifest
): Promise
<void
>
Parameters
Name | Type |
---|---|
packageName | string |
manifest | Manifest |
Returns
Promise
<void
>
Defined in
deletePackage
▸ deletePackage(fileName
): Promise
<void
>
Parameters
Name | Type |
---|---|
fileName | string |
Returns
Promise
<void
>
Defined in
hasPackage
▸ hasPackage(): Promise
<boolean
>
Returns
Promise
<boolean
>
Defined in
hasTarball
▸ hasTarball(fileName
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
fileName | string |
Returns
Promise
<boolean
>
Defined in
readPackage
▸ readPackage(packageName
): Promise
<Manifest
>
Parameters
Name | Type |
---|---|
packageName | string |
Returns
Promise
<Manifest
>
Defined in
readTarball
▸ readTarball(fileName
, «destructured»
): Promise
<Readable
>
Parameters
Name | Type |
---|---|
fileName | string |
«destructured» | Object |
› signal | AbortSignal |
Returns
Promise
<Readable
>
Defined in
removePackage
▸ removePackage(): Promise
<void
>
Returns
Promise
<void
>
Defined in
savePackage
▸ savePackage(packageName
, manifest
): Promise
<void
>
Parameters
Name | Type |
---|---|
packageName | string |
manifest | Manifest |
Returns
Promise
<void
>
Defined in
updatePackage
▸ updatePackage(packageName
, handleUpdate
): Promise
<Manifest
>
Parameters
Name | Type |
---|---|
packageName | string |
handleUpdate | (manifest : Manifest ) => Promise <Manifest > |
Returns
Promise
<Manifest
>
Defined in
writeTarball
▸ writeTarball(fileName
, «destructured»
): Promise
<Writable
>
Parameters
Name | Type |
---|---|
fileName | string |
«destructured» | Object |
› signal | AbortSignal |
Returns
Promise
<Writable
>