snyk-nodejs-lockfile-parser/dist/parsers/yarn-lock-parser.d.ts

Generate a dep tree given a lockfile

import { Dep, Lockfile, LockfileType, ManifestFile, PkgTree } from './index';
import { DepMap, LockParserBase } from './lock-parser-base';
export declare type YarnLockFileTypes = LockfileType.yarn | LockfileType.yarn2;
export interface YarnLock {
    type: string;
    object: YarnLockDeps;
    dependencies?: YarnLockDeps;
    lockfileType: YarnLockFileTypes;
}
export interface YarnLockDeps {
    [depName: string]: YarnLockDep;
}
export interface YarnLockDep {
    version: string;
    dependencies?: {
        [depName: string]: string;
    };
    optionalDependencies?: {
        [depName: string]: string;
    };
}
export declare class YarnLockParser extends LockParserBase {
    constructor();
    parseLockFile(lockFileContents: string): YarnLock;
    getDependencyTree(manifestFile: ManifestFile, lockfile: Lockfile, includeDev?: boolean, strictOutOfSync?: boolean): Promise<PkgTree>;
    protected getDepMap(lockfile: Lockfile): DepMap;
    protected getDepTreeKey(dep: Dep): string;
}