Logo for jsDocs.io

snyk-paket-parser

  • Version 1.6.0
  • Published
  • 40.4 kB
  • 1 dependency
  • Apache-2.0 license

Install

npm i snyk-paket-parser
yarn add snyk-paket-parser
pnpm add snyk-paket-parser

Overview

Generate a dep tree given a collection of manifests

Index

Functions

Classes

Interfaces

Enums

Functions

function buildDepTreeFromFiles

buildDepTreeFromFiles: (
    root: string,
    manifestFilePath: string,
    lockFilePath: string,
    includeDev?: boolean,
    strict?: boolean
) => Promise<DepTree>;

    Classes

    class InvalidUserInputError

    class InvalidUserInputError extends Error {}

      constructor

      constructor(...args: any[]);

        property code

        code: number;

          property name

          name: string;

            class OutOfSyncError

            class OutOfSyncError extends Error {}

              constructor

              constructor(dependencyName: string);

                property code

                code: number;

                  property dependencyName

                  dependencyName: string;

                    property lockFileType

                    lockFileType: string;

                      property name

                      name: string;

                        Interfaces

                        interface DepTree

                        interface DepTree {}

                          property dependencies

                          dependencies: {
                              [dep: string]: DepTree;
                          };

                            property depType

                            depType?: DepType;

                              property hasDevDependencies

                              hasDevDependencies?: boolean;

                                property missingLockFileEntry

                                missingLockFileEntry?: boolean;

                                  property name

                                  name: string;

                                    property targetFrameworks

                                    targetFrameworks?: string[];

                                      property version

                                      version: string;

                                        Enums

                                        enum DepType

                                        enum DepType {
                                            prod = 'prod',
                                            dev = 'dev',
                                        }

                                          member dev

                                          dev = 'dev'

                                            member prod

                                            prod = 'prod'

                                              Package Files (3)

                                              Dependencies (1)

                                              Dev Dependencies (7)

                                              Peer Dependencies (0)

                                              No peer dependencies.

                                              Badge

                                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/snyk-paket-parser.

                                              • Markdown
                                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/snyk-paket-parser)
                                              • HTML
                                                <a href="https://www.jsdocs.io/package/snyk-paket-parser"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>