Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve typings #497

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 3 additions & 15 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,7 @@ import * as http from 'http';

export = FormData;

// Extracted because @types/node doesn't export interfaces.
interface ReadableOptions {
highWaterMark?: number;
encoding?: string;
objectMode?: boolean;
read?(this: stream.Readable, size: number): void;
destroy?(this: stream.Readable, error: Error | null, callback: (error: Error | null) => void): void;
autoDestroy?: boolean;
}

interface Options extends ReadableOptions {
interface Options extends stream.ReadableOptions {
writable?: boolean;
readable?: boolean;
dataSize?: number;
Expand All @@ -29,7 +19,7 @@ interface Options extends ReadableOptions {

declare class FormData extends stream.Readable {
constructor(options?: Options);
append(key: string, value: any, options?: FormData.AppendOptions | string): void;
append(key: string, value: unknown, options?: FormData.AppendOptions | string): void;
getHeaders(userHeaders?: FormData.Headers): FormData.Headers;
submit(
params: string | FormData.SubmitOptions,
Expand All @@ -44,9 +34,7 @@ declare class FormData extends stream.Readable {
}

declare namespace FormData {
interface Headers {
[key: string]: any;
}
type Headers = Record<string, number | string | string[]>;

interface AppendOptions {
header?: string | Headers;
Expand Down