Class NpmApi

Hierarchy

NpmApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NpmApi(basePath?: string): NpmApi

- Defined in api/api.ts:51379
Parameters
- Optional basePath: string
Returns NpmApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

deletePackageVersionFromRecycleBin

deletePackageVersionFromRecycleBin(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:51396
Delete a package version without an npm scope from the recycle bin.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

deleteScopedPackageVersionFromRecycleBin

deleteScopedPackageVersionFromRecycleBin(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:51461
Delete a package version with an npm scope from the recycle bin.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageScope: string
  - packageVersion: string
  - unscopedPackageName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

getContentScopedPackageAsync

getContentScopedPackageAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

- Defined in api/api.ts:51531
Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageScope: string
  - packageVersion: string
  - unscopedPackageName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<string>

getContentUnscopedPackageAsync

getContentUnscopedPackageAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

- Defined in api/api.ts:51600
Get an unscoped npm package.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<string>

getPackageInfoAsync

getPackageInfoAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ModelPackage>

- Defined in api/api.ts:51664
Get information about an unscoped package version.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ModelPackage>

getPackageVersionMetadataFromRecycleBin

getPackageVersionMetadataFromRecycleBin(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<NpmPackageVersionDeletionState>

- Defined in api/api.ts:51728
Get information about an unscoped package version in the recycle bin.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<NpmPackageVersionDeletionState>

getReadmeScopedPackageAsync

getReadmeScopedPackageAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

- Defined in api/api.ts:51793
Get the Readme for a package version with an npm scope.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageScope: string
  - packageVersion: string
  - unscopedPackageName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<string>

getReadmeUnscopedPackageAsync

getReadmeUnscopedPackageAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

- Defined in api/api.ts:51862
Get the Readme for a package version that has no npm scope.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<string>

getScopedPackageInfoAsync

getScopedPackageInfoAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ModelPackage>

- Defined in api/api.ts:51927
Get information about a scoped package version (such as @scope/name).

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageScope: string
  - packageVersion: string
  - unscopedPackageName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ModelPackage>

getScopedPackageVersionMetadataFromRecycleBin

getScopedPackageVersionMetadataFromRecycleBin(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<NpmPackageVersionDeletionState>

- Defined in api/api.ts:51997
Get information about a scoped package version in the recycle bin.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageScope: string
  - packageVersion: string
  - unscopedPackageName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<NpmPackageVersionDeletionState>

restorePackageVersionFromRecycleBin

restorePackageVersionFromRecycleBin(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:52067
Restore a package version without an npm scope from the recycle bin to its feed.

Parameters
- params: object
  - apiVersion: string
  - body: NpmRecycleBinPackageVersionDetails
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

restoreScopedPackageVersionFromRecycleBin

restoreScopedPackageVersionFromRecycleBin(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:52140
Restore a package version with an npm scope from the recycle bin to its feed.

Parameters
- params: object
  - apiVersion: string
  - body: NpmRecycleBinPackageVersionDetails
  - feedId: string
  - organization: string
  - packageScope: string
  - packageVersion: string
  - unscopedPackageName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

unpublishPackageAsync

unpublishPackageAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ModelPackage>

- Defined in api/api.ts:52216
Unpublish an unscoped package version.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ModelPackage>

unpublishScopedPackageAsync

unpublishScopedPackageAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ModelPackage>

- Defined in api/api.ts:52281
Unpublish a scoped package version (such as @scope/name).

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageScope: string
  - packageVersion: string
  - unscopedPackageName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ModelPackage>

updatePackageAsync

updatePackageAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ModelPackage>

- Defined in api/api.ts:52351
Parameters
- params: object
  - apiVersion: string
  - body: PackageVersionDetails
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ModelPackage>

updatePackagesAsync

updatePackagesAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:52421
Update several packages from a single feed in a single request. The updates to the packages do not happen atomically.

Parameters
- params: object
  - apiVersion: string
  - body: NpmPackagesBatchRequest
  - feedId: string
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

updateScopedPackageAsync

updateScopedPackageAsync(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ModelPackage>

- Defined in api/api.ts:52484
Parameters
- params: object
  - apiVersion: string
  - body: PackageVersionDetails
  - feedId: string
  - organization: string
  - packageScope: string
  - packageVersion: string
  - unscopedPackageName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ModelPackage>

Generated using TypeDoc