Merge pull request #434 from ScriptSmith/master

mapleeit · web-flow · commit 06568edb6d79 · 2019-09-03T23:28:03.000+08:00
Fix the getHeaders method signatures
diff --git a/Readme.md b/Readme.md
@@ -187,7 +187,7 @@ form.submit({
 ### Methods
 
 - [_Void_ append( **String** _field_, **Mixed** _value_ [, **Mixed** _options_] )](https://github.com/form-data/form-data#void-append-string-field-mixed-value--mixed-options-).
-- [_Array_ getHeaders( [**Array** _userHeaders_] )](https://github.com/form-data/form-data#array-getheaders-array-userheaders-)
+- [_Headers_ getHeaders( [**Headers** _userHeaders_] )](https://github.com/form-data/form-data#array-getheaders-array-userheaders-)
 - [_String_ getBoundary()](https://github.com/form-data/form-data#string-getboundary)
 - [_Buffer_ getBuffer()](https://github.com/form-data/form-data#buffer-getbuffer)
 - [_Integer_ getLengthSync()](https://github.com/form-data/form-data#integer-getlengthsync)
@@ -216,7 +216,7 @@ form.append( 'my_file', fs.createReadStream('/foo/bar.jpg'), 'bar.jpg' );
 form.append( 'my_file', fs.createReadStream('/foo/bar.jpg'), {filename: 'bar.jpg', contentType: 'image/jpeg', knownLength: 19806} );
 ```
 
-#### _Array_ getHeaders( [**Array** _userHeaders_] )
+#### _Headers_ getHeaders( [**Headers** _userHeaders_] )
 This method ads the correct `content-type` header to the provided array of `userHeaders`.  
 
 #### _String_ getBoundary()
diff --git a/index.d.ts b/index.d.ts
@@ -20,7 +20,7 @@ interface Options {
 declare class FormData extends stream.Readable {
   constructor(options?: Options);
   append(key: string, value: any, options?: FormData.AppendOptions | string): void;
-  getHeaders(): FormData.Headers;
+  getHeaders(userHeaders?: FormData.Headers): FormData.Headers;
   submit(
     params: string | FormData.SubmitOptions,
     callback?: (error: Error | null, response: http.IncomingMessage) => void
