From dd56e50ad6f26dda8f5ed19a55574acd27a1a272 Mon Sep 17 00:00:00 2001 From: Sven Slootweg Date: Tue, 17 Mar 2015 17:04:53 +0100 Subject: [PATCH] v1.0.3: Documentation fix. --- README.md | 1 + package.json | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 78ba4d9..58ed54a 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ While `form-data2` was designed to be roughly API-compatible with the `form-data * `form-data2` does __not__ do HTTP requests. It is purely a multipart/form-data encoder. This means you should use a different module for your HTTP requests, such as [`bhttp`](https://www.npmjs.com/package/bhttp), [`request`](https://www.npmjs.com/package/request), or the core `http` module. `bhttp` uses `form-data2` internally - that means you won't have to manually use `form-data2`. * The `header` option for the `form.append()` options object is not (yet) implemented. This means that you cannot currently set custom field headers. * There is no `form.getLengthSync()` method. Length retrieval is always asynchronous. +* The `form.getHeaders` method is __always asynchronous__ (whereas in the original `form-data`, it is synchronous). Due to the requirements for obtaining the stream length reliably, there is no synchronous equivalent. * A `form-data2` stream is not a real stream. Only the `form.pipe()` method is implemented, other stream methods are unavailable. This may change in the future. ## Usage diff --git a/package.json b/package.json index b836989..8ed041d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "form-data2", - "version": "1.0.2", + "version": "1.0.3", "description": "A Streams2-compatible drop-in replacement for the `form-data` module.", "main": "index.js", "scripts": {