package-json-type
    Preparing search index...

    Interface IDirectories

    You can specify exact locations to put binary files, man pages, documentation, examples, etc. Package manager tools must use these directory definitions to find various package components.

    {
      "directories": {
        "lib": "path/to/lib/",
        "bin": "path/to/bin/",
        "man": "path/to/man/",
        "doc": "path/to/doc/",
        "example": "path/to/example/"
      }
    }
    interface IDirectories {
        bin?: string;
        doc?: string;
        example?: string;
        lib?: string;
        man?: string;
        test?: string;
    }
    Index

    Properties

    bin? doc? example? lib? man? test?

    Properties

    bin?: string

    If you specify a bin directory in directories.bin, all the files in that folder will be added. Because of the way the bin directive works, specifying both a bin path and setting directories.bin is an error. If you want to specify individual files, use bin, and for all the files in an existing bin directory, use directories.bin.

    doc?: string

    Put markdown doc files in here.

    example?: string

    Put example scripts in here.

    lib?: string

    Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.

    man?: string

    A folder that is full of man pages. Sugar to generate a man array by walking the folder.

    test?: string

    Put your tests in here.

    Settings

    Member Visibility

    On This Page

    Properties