5.1.3 • Published 2 years ago

@types/lerna__query-graph v5.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Installation

npm install --save @types/lerna__query-graph

Summary

This package contains type definitions for @lerna/project (https://github.com/lerna/lerna/tree/main/utils/query-graph).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lerna__query-graph.

index.d.ts

// Type definitions for @lerna/project 5.1
// Project: https://github.com/lerna/lerna/tree/main/utils/query-graph
// Definitions by: DonMahallem <https://github.com/donmahallem>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import { Package } from '@lerna/package';
import { PackageGraphNode } from '@lerna/package-graph';

export interface QueryGraphConfig {
    /**
     * "dependencies" excludes devDependencies from graph
     */
    graphType?: 'allDependencies' | 'dependencies';
    /**
     * Whether or not to reject dependency cycles
     */
    rejectCycles?: boolean;
}
/**
 * A mutable PackageGraph used to query for next available packages.
 */
export class QueryGraph {
    /**
     * @param packages An array of Packages to build the list out of
     * @param [options]
     */
    static toposort(packages: Package[], options?: QueryGraphConfig): Package[];

    constructor(packages: Package[], options?: QueryGraphConfig);

    getAvailablePackages(): Package[];
    markAsTaken(name: string): void;
    markAsDone(candidateNode: PackageGraphNode): void;
}
export const toposort: typeof QueryGraph.toposort;

Additional Details

Credits

These definitions were written by DonMahallem.