express-autoindex/dist/types/src/interface.d.ts

express-autoindex produce a directory listing like Nginx, Apache or another, but just with express

import type { Dirent } from 'fs';
export type errorMap = Map<string, {
    message: string;
    httpCode: number;
}>;
export type defaultKeyOfJson = 'isDir' | 'name' | 'path' | 'time' | 'size';
export interface autoIndexOptions {
    /**
     * Throw error for all HTTP error codes (**4xx** & **5xx**)
     *
     *  By default, errors will be generated only on **5xx** types. If you wish to generate an error regardless of the HTTP error code, pass `true` to the option
     *
     * * Default to `false`
     */
    alwaysThrowError?: boolean;
    /**
     * Caches for a defined time the generated pages. Very useful to save server resources
     *
     * Pass `false` to disable the cache, or the number of milliseconds representing the cache expiration time
     *
     * Default to `300000` => 5 mins
     */
    cache?: number | false;
    /**
     * Custom JSON format
     *
     * By default, the json generated for a file or folder follows a precise structure. It is possible to rename or remove the **key** of this object.
     *
     * For more details, see `README.md`
     *
     * Default to `undefined`
     */
    customJsonFormat?: {
        isDir?: string;
        name?: string;
        path?: string;
        time?: string;
        size?: string;
    };
    /**
     * Pass custom page template
     *
     * Pass the relative path of your custom template file. For example, if the file is located in the same folder of your startup server file, simply write `my-file.html` or `./my-file.html`.
     *
     * For more details, see `README.md`
     *
     * Default to `undefined`
     */
    customTemplate?: string;
    /**
     * Custom date print format
     *
     * For more details, see `README.md`
     *
     * Default to `undefined`
     */
    dateFormat?: string;
    /**
     * Display directories before files
     *
     * Default to `false`
     */
    dirAtTop?: boolean;
    /**
     * Display the last modification date of the file or directory if available
     *
     * Default to `true`
     */
    displayDate?: boolean;
    /**
     * Display dotfiles (.env, .yarnrc, ...)
     *
     * Default to `false`
     */
    displayDotfile?: boolean;
    /**
     * Display size of the file or directory if available
     *
     * Default to `true`
     */
    displaySize?: boolean;
    /**
     * Regular expression for files/dirs exclude, for example `/my-file.json|\*.cpp/`
     */
    exclude?: RegExp;
    /**
     * Send data in json format instead of an html page. Might be useful if you want to use the data for another application
     *
     * Default to `false`
     */
    json?: boolean;
    /**
     * Allow only `HEAD` and `GET` HTTP methods
     *
     * Default to `true`
     */
    strict?: boolean;
}
export interface statFile {
    dirent: Dirent;
    el: {
        dirent: string[];
        size: string;
        time: string;
    };
}
export interface serveConfig {
    path: string;
    savePath: string;
    serverPath: string;
    title: string;
}
export interface save {
    json: boolean;
    data: string | Record<string, any>;
    deadline: Date;
    path: string;
}
export interface dateRegexGroups {
    year: string;
    month: string;
    day: string;
    hours: string;
    minutes: string;
    seconds: string;
    milliseconds: string;
}
//# sourceMappingURL=interface.d.ts.map