universal-fs/dist/server/server.d.ts

Allows a client or server to access the file system in the current codebase or a different one.

import type { Express } from "express";
import http from "http";
/**
 * The class for controllering the file relay server.
 */
declare class Server {
    private app;
    private port;
    private server;
    private isProtected;
    /**
     * An optional custom function to use your own Express server.
     * @param app - The express app
     * @param server - The http server
     * @returns The url of your custom server
     */
    private startServer?;
    /**
     * The constructor of the class for controllering the file relay server.
     * @param startServer - An optional custom function to use your own Express server
     */
    constructor(options?: {
        /**
         * Whether the server should require a password for readOperations on non-ignored files
         * @default true
         */
        isProtected?: boolean;
        /** An optional object with options for configuring the server */
        startServer?: (app: Express, server?: http.Server) => Promise<string> | string;
    });
    /**
     * Initilizes the file relay server
     * @returns The url to the open Ngrok tunnel
     * @async
     */
    init(): Promise<string | null>;
    /**
     * Stops the server by closing the current connection.
     */
    stop(): void;
}
export default Server;