[Pkg-javascript-commits] [node-module-deps] 276/444: document input format

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-module-deps.

commit 16a9727fa593ecba212bca41b8e0da29416bc178
Author: James Halliday <mail at substack.net>
Date:   Tue Jul 22 23:15:56 2014 -0700

    document input format
---
 readme.markdown | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/readme.markdown b/readme.markdown
index 7696f72..8f99e5e 100644
--- a/readme.markdown
+++ b/readme.markdown
@@ -52,7 +52,7 @@ usage: module-deps [files]
 var mdeps = require('module-deps')
 ```
 
-## var d = mdeps(files, opts={})
+## var d = mdeps(opts={})
 
 Return an object transform stream `d` that expects entry filenames or
 `{ id: ..., file: ... }` objects as input and produces objects for every
@@ -96,6 +96,13 @@ in `process.env.NODE_PATH`
 
 * `opts.ignoreMissing` - ignore files that failed to resolve
 
+# input objects
+
+Input objects should be string filenames or objects with these parameters:
+
+`row.file` - filename
+`row.expose` - name to be exposed as
+
 # events
 
 ## d.on('transform', function (tr, file) {})

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-module-deps.git