@types/libnpmpublish
TypeScript icon, indicating that this package has built-in type declarations

4.0.6 • Public • Published

Installation

npm install --save @types/libnpmpublish

Summary

This package contains type definitions for libnpmpublish (https://npmjs.com/package/libnpmpublish).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/libnpmpublish.

index.d.ts

import { PackageJson } from "@npm/types";
import fetch = require("npm-registry-fetch");
import { Response } from "node-fetch";

/**
 * Sends the package represented by the manifest and tarData to the configured registry.
 * @param manifest the parsed package.json for the package being published (which can also be the manifest pulled from a packument, a git repo, tarball, etc.)
 * @param tarballData a Buffer of the tarball being published.
 * @param options (optional) a object containing the options
 * @returns a Promise that resolves to a Response
 * @example // note that pacote.manifest() and pacote.tarball() can also take
 * // any spec that npm can install.  a folder shown here, since that's
 * // far and away the most common use case.
 * const path = '/a/path/to/your/source/code'
 * const pacote = require('pacote') // see: http://npm.im/pacote
 * const manifest = await pacote.manifest(path)
 * const tarData = await pacote.tarball(path)
 * await libpub.publish(manifest, tarData, { npmVersion: 'my-pub-script@1.0.2', token: 'my-auth-token-here' }, opts)
 * // Package has been published to the npm registry.
 */
export function publish(manifest: PackageJson, tarballData: Buffer, options?: fetch.Options): Promise<Response>;

/**
 * Unpublishes spec from the appropriate registry. The registry in question may have its own limitations on unpublishing.
 * @param spec either a string, or a valid npm-package-arg parsed spec object. For legacy compatibility reasons, only tag and version specs will work as expected.
 * @param options (optional) a object containing the options
 * @returns a Promise that resolves to a Boolean
 * @example await libpub.unpublish('lodash', { token: 'my-auth-token-here'})
 *          //
 *          // `lodash` has now been unpublished, along with all its versions
 */
export function unpublish(spec: string | object, options?: fetch.Options): Promise<boolean>;

Additional Details

Credits

These definitions were written by Nicolas Rodriguez, and Guy Adler.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/libnpmpublish

Weekly Downloads

4,176

Version

4.0.6

License

MIT

Unpacked Size

6.9 kB

Total Files

5

Last publish

Collaborators

  • types