Installation

npm install --save @types/hapi__mimos

Summary

This package contains type definitions for @hapi/mimos (https://github.com/hapijs/mimos).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hapi__mimos.

index.d.ts

1// Type definitions for @hapi/mimos 4.1
2// Project: https://github.com/hapijs/mimos
3// Definitions by: AJP <https://github.com/AJamesPhillips>
4//                 Silas Rech <https://github.com/lenovouser>
5//                 Linus Unnebäck <https://github.com/LinusU>
6//                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
7// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
8
9import { MimeEntry } from 'mime-db';
10
11declare namespace Mimos {
12    /**
13     *
14     * @see {@link https://github.com/hapijs/mimos#new-mimosoptions}
15     */
16    interface MimosOptions {
17        /**
18         * an object hash that is merged into the built in mime information specified here {@link https://github.com/jshttp/mime-db}.
19         * Each key value pair represents a single mime object.
20         * Each override value should follow this schema:
21         *  * the key is the lower-cased correct mime-type. (Ex. "application/javascript").
22         *  * the value should an object @see MimosOptionsValue
23         */
24        override: {
25            [type: string]: MimosOptionsValue & {
26                /**
27                 * Method with signature function(mime) when this mime type is found in the database,
28                 * this function will run. This allows you make customizations to mime based on developer criteria.
29                 */
30                predicate?: ((
31                    mime: MimosOptionsValue & {
32                        [key: string]: any;
33                    },
34                ) => MimosOptionsValue & {
35                    [key: string]: any;
36                }) | undefined;
37            };
38        };
39    }
40
41    interface MimosOptionsValue extends MimeEntry {
42        /**
43         * Specify the type value of result objects, defaults to key.
44         */
45        type?: string | undefined;
46    }
47}
48
49declare class Mimos {
50    /**
51     * Creates a new Mimos object.
52     */
53    constructor(options?: Mimos.MimosOptions);
54    /**
55     * Returns mime object
56     */
57    path(path: string): Mimos.MimosOptionsValue;
58    /**
59     * Returns mime object
60     */
61    type(type: string): MimeEntry;
62}
63
64export = Mimos;
65

Additional Details

• Last updated: Tue, 06 Jul 2021 20:33:13 GMT
• Dependencies: @types/mime-db
• Global values: none

Credits

These definitions were written by AJP, Silas Rech, Linus Unnebäck, and Piotr Błażejewicz.