From d9085ea0cb73bfeb6c0c9bb89dc39ecc840f9dae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20Geisend=C3=B6rfer?= Date: Tue, 5 Jan 2010 22:50:00 +0100 Subject: [PATCH] Updated docs for multipart errors --- doc/api.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/api.txt b/doc/api.txt index 698accb91a..7d81f838fa 100644 --- a/doc/api.txt +++ b/doc/api.txt @@ -1134,9 +1134,11 @@ Node. To use it, +require("multipart")+. +multipart.parse(options)+ :: - on success: Returns an object where each key holds the value of one part of the stream. +options+ can either be an instance of - +http.ServerRequest+ or an object containing a "boundary" and a - "data" key. - - on error: no parameters. + +http.ServerRequest+ or an object containing a "boundary" and + an optional "data" key. + - on error: Returns an instanceof Error object. Right now only the request + content-type / boundary option is checked. The stream data itself + is not validated. ==== +multipart.Stream+