Documentation
    Preparing search index...

    Interface CollectWorkspaceOnlyOptions

    interface CollectWorkspaceOnlyOptions {
        dependencyCriteria?: (string | RegExp)[];
        onlyWorkspaceRoot?: boolean;
        packageJsonMatcher?: JsonMatcherFrom<
            Replace<JSONSchemaForNPMPackageJsonFiles, SimplifiedPackageJsonFields>,
        >;
        skipWorkspaceRoot?: boolean;
    }
    Index
    dependencyCriteria?: (string | RegExp)[]

    Return only those packages that list these dependencies among either dependencies or devDependencies. When it's not defined or is an empty array, it will not perform such filtering.

    Note that while the packageJsonMatcher can also match dependencies, matching across multiple fields at the top level means that you're limited to only use a single function based matcher, or writing needlessly complicated boilerplate. So this field is here to trivialize this usecase.

    []
    
    onlyWorkspaceRoot?: boolean

    Only return the root workspace package

    false
    
    packageJsonMatcher?: JsonMatcherFrom<
        Replace<JSONSchemaForNPMPackageJsonFiles, SimplifiedPackageJsonFields>,
    >

    When defined only the packages where the package.json file is matching to this matcher are returned.

    skipWorkspaceRoot?: boolean

    Skip the root workspace package itself. Has no effect if the repo is not a monorepo!

    false