Interface Directories

The CommonJS Packages spec details a few ways that you can indicate the structure of your package using a directories object. If you look at npm's package.json, you'll see that it has directories for doc, lib, and man.

Hierarchy

  • Directories

Properties

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

Properties

Optional bin

bin?: string

If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.

Optional doc

doc?: string

Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.

Optional example

example?: string

Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.

Optional lib

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.

Optional man

man?: string

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

Optional test

test?: string

?

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc