@types/async-busboy NPM

Installation

npm install --save @types/async-busboy

Summary

This package contains type definitions for async-busboy (https://github.com/m4nuC/async-busboy#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/async-busboy.

index.d.ts

// Type definitions for async-busboy 1.1
// Project: https://github.com/m4nuC/async-busboy#readme
// Definitions by: Hiroshi Ioka <https://github.com/hirochachacha>
//                 BendingBender <https://github.com/bendingbender>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import * as fs from 'fs';
import * as http from 'http';
import busboy = require('busboy');

export = asyncBusboy;

declare function asyncBusboy(
    req: http.IncomingMessage,
    options: asyncBusboy.OnFileOptions,
): Promise<asyncBusboy.OnFileResult>;
declare function asyncBusboy(req: http.IncomingMessage, options?: asyncBusboy.Options): Promise<asyncBusboy.Result>;

declare namespace asyncBusboy {
    interface Options extends Omit<busboy.BusboyConfig, 'headers'> {
        headers?: http.IncomingHttpHeaders | undefined;
        onFile?: busboy.BusboyEvents['file'] | undefined;
    }

    type OnFileOptions = WithRequiredProps<Options, 'onFile'>;

    interface Result {
        fields: { [key: string]: unknown };
        files: FileReadStream[];
    }

    type OnFileResult = Omit<Result, 'files'>;

    interface FileReadStream extends fs.ReadStream {
        fieldname: string;
        filename: string;
        transferEncoding: string;
        encoding: string;
        mimeType: string;
        mime: string;
    }
}

type WithRequiredProps<T extends {}, K extends keyof T> = Omit<T, K> & {
    [MK in K]-?: NonNullable<T[MK]>;
};