@contextjs/webserver-middleware-static

   

Static files middleware for the ContextJS webserver.

Installation

npm i @contextjs/webserver-middleware-static

Usage

import "@contextjs/webserver-middleware-static";

import { Application } from "@contextjs/system";
import { WebServerOptions } from "@contextjs/webserver";
import { StaticFilesOptions } from "@contextjs/webserver-middleware-static";

const application = new Application();

application.useWebServer((options: WebServerOptions) => {
    options.onEvent = e => console.log(`[WebServer:${e.type}]`, e.detail);
    options.useStaticFiles((staticFilesOptions: StaticFilesOptions) => {
        staticFilesOptions.publicFolder = "your-static-files_folder";
        staticFilesOptions.fileExtensions = ["png", "jpg", "jpeg", "gif"]; // Only allow these file types
        // staticFilesOptions.fileExtensions = []; // Uncomment to allow all file types
    });
});

await application.runAsync();

API Reference

WebServerOptions Extension

declare module "@contextjs/webserver" {
    export interface WebServerOptions {
        /**
         * Registers middleware to serve static files.
         * @param configure Callback used to configure static file behavior.
         */
        useStaticFiles(configure: (staticFilesOptions: StaticFilesOptions) => void): WebServerOptions;
    }
}

StaticFilesOptions

export class StaticFilesOptions {
    /**
     * Gets or sets the public folder from which static files are served.
     * Defaults to "public".
     */
    public publicFolder: string;

    /**
     * Gets or sets the list of allowed file extensions.
     * If empty, all file types are allowed.
     */
    public fileExtensions: string[];
}