fixturify-project

  • Version 4.0.2
  • Published
  • 26 kB
  • 5 dependencies
  • MIT license

Install

npm i fixturify-project
yarn add fixturify-project
pnpm add fixturify-project

Overview

[![CI](https://github.com/stefanpenner/node-fixturify-project/workflows/CI/badge.svg)](https://github.com/stefanpenner/node-fixturify-project/actions/workflows/ci.yml)

Index

Classes

class Project

class Project {}

    constructor

    constructor(
    name?: string,
    version?: string,
    args?: Omit<ProjectArgs, 'name' | 'version'>,
    projectCallback?: ProjectCallback
    );

      constructor

      constructor(
      name?: string,
      version?: string,
      args?: Omit<ProjectArgs, 'name' | 'version'>
      );

        constructor

        constructor(name?: string, version?: string, projectCallback?: ProjectCallback);

          constructor

          constructor(
          name?: string,
          args?: Omit<ProjectArgs, 'name'>,
          projectCallback?: ProjectCallback
          );

            constructor

            constructor(args?: ProjectArgs, projectCallback?: ProjectCallback);

              property baseDir

              baseDir: string;

                property files

                files: fixturify.DirJSON;

                  property isDependency

                  readonly isDependency: boolean;

                    property name

                    name: string;

                      property pkg

                      pkg: any;

                        property root

                        readonly root: void;

                          property version

                          version: string;

                            method addDependency

                            addDependency: {
                            (
                            name?: string,
                            version?: string,
                            args?: Omit<ProjectArgs, 'name' | 'version'>,
                            projectCallback?: ProjectCallback
                            ): Project;
                            (
                            name?: string,
                            version?: string,
                            projectCallback?: ProjectCallback
                            ): Project;
                            (
                            name?: string,
                            args?: Omit<ProjectArgs, 'name'>,
                            projectCallback?: ProjectCallback
                            ): Project;
                            (args?: ProjectArgs, projectCallback?: ProjectCallback): Project;
                            (args?: Project, projectCallback?: ProjectCallback): Project;
                            };

                              method addDevDependency

                              addDevDependency: {
                              (
                              name?: string,
                              version?: string,
                              args?: Omit<ProjectArgs, 'name' | 'version'>,
                              projectCallback?: ProjectCallback
                              ): Project;
                              (
                              name?: string,
                              version?: string,
                              projectCallback?: ProjectCallback
                              ): Project;
                              (
                              name?: string,
                              args?: Omit<ProjectArgs, 'name'>,
                              projectCallback?: ProjectCallback
                              ): Project;
                              (args?: ProjectArgs, projectCallback?: ProjectCallback): Project;
                              (args?: Project, projectCallback?: ProjectCallback): Project;
                              };

                                method clone

                                clone: () => Project;

                                  method dependencyProjects

                                  dependencyProjects: () => Project[];

                                    method devDependencyProjects

                                    devDependencyProjects: () => Project[];

                                      method dispose

                                      dispose: () => void;

                                        method fromDir

                                        static fromDir: (root: string, opts?: ReadDirOpts) => Project;

                                          method linkDependency

                                          linkDependency: (
                                          name: string,
                                          opts:
                                          | { baseDir: string; resolveName?: string; requestedRange?: string }
                                          | { target: string; requestedRange?: string }
                                          ) => void;

                                            method linkDevDependency

                                            linkDevDependency: (
                                            name: string,
                                            opts: { baseDir: string; resolveName?: string } | { target: string }
                                            ) => void;

                                              method removeDependency

                                              removeDependency: (name: string) => void;

                                                method removeDevDependency

                                                removeDevDependency: (name: string) => void;

                                                  method writeSync

                                                  writeSync: () => void;

                                                    Interfaces

                                                    interface ProjectArgs

                                                    interface ProjectArgs {}

                                                      property files

                                                      files?: fixturify.DirJSON;

                                                        property name

                                                        name?: string;

                                                          property requestedRange

                                                          requestedRange?: string;

                                                            property version

                                                            version?: string;

                                                              Package Files (1)

                                                              Dependencies (5)

                                                              Dev Dependencies (11)

                                                              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/fixturify-project.

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