DefinitelyTyped/types/express-fileupload/index.d.ts

// Type definitions for express-fileupload 1.1
// Project: https://github.com/richardgirges/express-fileupload#readme
// Definitions by: Gintautas Miselis <https://github.com/Naktibalda>
//                 Sefa Ilkimen <https://github.com/silkimen>
//                 Tomas Vosicky <https://github.com/vosatom>
//                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import express = require('express');

declare global {
    namespace Express {
        interface Request {
            files?: fileUpload.FileArray;
        }
    }
}

declare function fileUpload(options?: fileUpload.Options): express.RequestHandler;

declare namespace fileUpload {
    class FileArray {
        [index: string]: UploadedFile;
    }

    interface UploadedFile {
        /** file name */
        name: string;
        /** A function to move the file elsewhere on your server */
        mv(path: string, callback: (err: any) => void): void;
        mv(path: string): Promise<void>;
        /** Encoding type of the file */
        encoding: string;
        /** The mimetype of your file */
        mimetype: string;
        /** A buffer representation of your file, returns empty buffer in case useTempFiles option was set to true. */
        data: Buffer;
        /** A path to the temporary file in case useTempFiles option was set to true. */
        tempFilePath: string;
        /** A boolean that represents if the file is over the size limit */
        truncated: boolean;
        /** Uploaded size in bytes */
        size: number;
        /** MD5 checksum of the uploaded file */
        md5: string;
    }

    /**
     * @see {@link https://github.com/richardgirges/express-fileupload#available-options}
     */
    interface Options {
        /**
         * Automatically creates the directory path specified in `.mv(filePathName)`
         * @default false
         */
        createParentPath?: boolean;
        /**
         * Applies uri decoding to file names if set true.
         * @default false
         */
        uriDecodeFileNames?: boolean;
        /**
         * Strips characters from the upload's filename.
         * You can use custom regex to determine what to strip.
         * If set to true, non-alphanumeric characters except dashes and underscores will be stripped.
         * This option is off by default.
         * @default false
         */
        safeFileNames?: boolean | RegExp;
        /**
         * Preserves filename extension when using safeFileNames option.
         * If set to `true`, will default to an extension length of 3.
         * If set to `Number`, this will be the max allowable extension length.
         * If an extension is smaller than the extension length, it remains untouched. If the extension is longer, it is shifted.
         * @default false
         */
        preserveExtension?: boolean | number;
        /**
         * Returns a HTTP 413 when the file is bigger than the size limit if `true`.
         * Otherwise, it will add a `truncated = true` to the resulting file structure.
         * @default false
         */
        abortOnLimit?: boolean;
        /**
         * Response which will be send to client if file size limit exceeded when `abortOnLimit` set to `true`.
         * @default 'File size limit has been reached'
         */
        responseOnLimit?: string;
        /**
         * User defined limit handler which will be invoked if the file is bigger than configured limits.
         * @default false
         */
        limitHandler?: boolean | express.RequestHandler;
        /**
         * By default this module uploads files into RAM.
         * Setting this option to True turns on using temporary files instead of utilising RAM. This avoids memory overflow issues when uploading large files
         * or in case of uploading lots of files at same time.
         * @default false
         */
        useTempFiles?: boolean;
        /**
         * Path to store temporary files.
         * Used along with the `useTempFiles` option.
         * By default this module uses 'tmp' folder in the current working directory.
         * You can use trailing slash, but it is not necessary.
         * @default '/tmp'
         */
        tempFileDir?: string;
        /**
         * By default, `req.body` and `req.files`
         * are flattened like this: `{'name': 'John', 'hobbies[0]': 'Cinema', 'hobbies[1]': 'Bike'}`
         *
         * When this option is enabled they are parsed in order to be nested like this:
         * `{'name': 'John', 'hobbies': ['Cinema', 'Bike']}`
         * @default false
         */
        parseNested?: boolean;
        /**
         * Turn on/off upload process logging.
         * Can be useful for troubleshooting.
         * @default false
         */
        debug?: boolean;

        /**
         * @default 60000
         */
        uploadTimeout?: number;
        [property: string]: any;
    }
}

export = fileUpload;