Type alias JimpexStaticsOptions

JimpexStaticsOptions: {
    enabled: boolean;
    folder?: string;
    onHome: boolean;
    route: string;
}

The options for the middleware that serves static files.

Type declaration

  • enabled: boolean

    Whether or not to enable the middleware.

    Default

    true
    
  • Optional folder?: string

    By default, the folder will be the same as the route, but you can use this option to define a relative path that won't affect the route.

    Default

    ''
    
  • onHome: boolean

    If true, the path to the statics folder will be relative to the project root directory, otherwise, it will be relative to the directory where the app executable file is located.

    Default

    false
    
  • route: string

    The name of both the route and the folder, relative to whatever you defined with the onHome option.

    Default

    'statics'
    

Generated using TypeDoc