diff options
| author | Elan Shanker <elan.shanker@gmail.com> | 2014-12-13 16:06:56 -0500 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2015-08-29 00:58:29 -0400 |
| commit | 62c8948109e7c8536f683b34d414ae500c48e91f (patch) | |
| tree | 052e355636cc2c448f619df5c8cd387ee5a66399 | |
| parent | 6502160294ee86033936b1c25b645705a6760178 (diff) | |
| download | node-62c8948109e7c8536f683b34d414ae500c48e91f.tar.gz | |
doc: fix Folders as Modules omission of index.json
This section was inconsistent with the actual behavior of `require` and
with other parts of this same document, which do describe the ability
to treat index.json as a module’s default file.
PR-URL: https://github.com/joyent/node/pull/8868
Reviewed-By: jasnell - James M Snell <jasnell@gmail.com>
| -rw-r--r-- | doc/api/modules.markdown | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/api/modules.markdown b/doc/api/modules.markdown index 2e08ae172..b04d39ace 100644 --- a/doc/api/modules.markdown +++ b/doc/api/modules.markdown @@ -197,12 +197,13 @@ If this was in a folder at `./some-library`, then This is the extent of Node's awareness of package.json files. -If there is no package.json file present in the directory, then node -will attempt to load an `index.js` or `index.node` file out of that +If there is no package.json file present in the directory, then node will +attempt to load an `index.js`, `index.json`, or `index.node` file out of that directory. For example, if there was no package.json file in the above example, then `require('./some-library')` would attempt to load: * `./some-library/index.js` +* `./some-library/index.json` * `./some-library/index.node` ## Caching |