Installation

npm install --save @types/pnpapi

Summary

This package contains type definitions for pnpapi (https://yarnpkg.github.io/berry/advanced/pnpapi).

Details

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

index.d.ts

// Type definitions for pnpapi 0.0
// Project: https://yarnpkg.github.io/berry/advanced/pnpapi
// Definitions by: Maël Nison <https://github.com/arcanis>
//                 ExE Boss <https://github.com/ExE-Boss>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

export interface PhysicalPackageLocator {
    name: string;
    reference: string;
}

export interface TopLevelPackageLocator {
    name: null;
    reference: null;
}

export type PackageLocator =
    | PhysicalPackageLocator
    | TopLevelPackageLocator;

export interface PackageInformation {
    packageLocation: string;
    packageDependencies: Map<string, string | [string, string]>;
}

export const VERSIONS: {std: number, [key: string]: number};

export const topLevel: {name: null, reference: null};

export function getPackageInformation(locator: PackageLocator): PackageInformation;
export function findPackageLocator(location: string): PackageLocator | null;

export function resolveToUnqualified(request: string, issuer: string | null, opts?: {considerBuiltins?: boolean | undefined}): string | null;
export function resolveUnqualified(unqualified: string, opts?: { extensions?: string[] | undefined }): string;
export function resolveRequest(
    request: string,
    issuer: string | null,
    opts?: { considerBuiltins?: boolean | undefined; extensions?: string[] | undefined }
): string | null;

export function setup(): void;

declare global {
    namespace NodeJS {
        interface ProcessVersions {
            pnp?: string | undefined;
        }
    }
}

Additional Details

Last updated: Thu, 08 Jul 2021 20:19:41 GMT
Dependencies: none
Global values: none

Credits

These definitions were written by Maël Nison, and ExE Boss.

Current Tags

3 Versions

0.0.2 ... 5 years ago
0.0.1 ... 6 years ago
0.0.0 ... 7 years ago