@types/yarnpkg__lockfile
Version:
TypeScript definitions for @yarnpkg/lockfile
47 lines (37 loc) • 1.2 kB
Markdown
# Installation
> `npm install --save @types/yarnpkg__lockfile`
# Summary
This package contains type definitions for @yarnpkg/lockfile (https://github.com/yarnpkg/yarn/tree/master/packages/lockfile).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yarnpkg__lockfile.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yarnpkg__lockfile/index.d.ts)
````ts
export interface Dependency {
[packageName: string]: string;
}
export interface FirstLevelDependency {
version: string;
resolved?: string | undefined;
dependencies?: Dependency | undefined;
}
export interface LockFileObject {
[packageName: string]: FirstLevelDependency;
}
export function parse(
file: string,
fileLoc?: string,
): {
type: "success" | "merge" | "conflict";
object: LockFileObject;
};
export function stringify(
json: any,
noHeader?: boolean,
enableVersions?: boolean,
): string;
````
### Additional Details
* Last updated: Tue, 07 Nov 2023 15:11:36 GMT
* Dependencies: none
# Credits
These definitions were written by [Eric Wang](https://github.com/fa93hws).