Class ImplementationAbstract

constructor

• new Implementation(options): Implementation

• Parameters

  • options: {
        bind: string;
        compression: {
            http: {
                enabled: boolean;
                maxSize: number;
                minSize: number;
                preferOrder: CompressionAlgorithm[];
            };
            ws: {
                enabled: boolean;
                maxSize: number;
            };
        };
        logging: {
            debug: boolean;
            error: boolean;
            warn: boolean;
        };
        methods: {
            head: boolean;
            trace: boolean;
        };
        performance: {
            eTag: boolean;
            lastModified: boolean;
        };
        port: number;
        proxy: {
            compress: boolean;
            credentials: {
                authenticate: boolean;
                password: string;
                username: string;
            };
            enabled: boolean;
            force: boolean;
            header: Lowercase<string>;
            ips: {
                list: (Subnet<4 | 6> | IPAddress<4 | 6>)[];
                mode: "whitelist" | "blacklist";
                validate: boolean;
            };
        };
        version: boolean;
    }

    • bind: string

      THe IP Address to bind the server to

      Default

      "0.0.0.0"
      Copy

      Since

      0.0.4

    • compression: {
          http: {
              enabled: boolean;
              maxSize: number;
              minSize: number;
              preferOrder: CompressionAlgorithm[];
          };
          ws: {
              enabled: boolean;
              maxSize: number;
          };
      }

      Various Compression-Related Settings

      Since

      9.0.0

      • http: {
            enabled: boolean;
            maxSize: number;
            minSize: number;
            preferOrder: CompressionAlgorithm[];
        }

        HTTP Compression Settings

        Since

        9.0.0

        • enabled: boolean

          Whether HTTP Compression is enabled

          Default

          true
          Copy

          Since

          9.0.0

        • maxSize: number

          The Maximum Size of an Item allowed to be compressed

          Default

          size(10).mb()
          Copy

          Since

          9.0.0

        • minSize: number

          The Minimum Size of an Item allowed to be compressed

          Default

          size(1).kb()
          Copy

        • preferOrder: CompressionAlgorithm[]

          The Order in which to prefer Compression Algorithms, non included wont be used

          Default

          ["brotli", "gzip", "deflate"]
          Copy

          Since

          9.0.0

      • ws: {
            enabled: boolean;
            maxSize: number;
        }

        WebSocket Compression Settings

        Since

        9.0.0

        • enabled: boolean

          Whether WebSocket Compression is enabled

          Default

          true
          Copy

          Since

          9.0.0

        • maxSize: number

          The Maximum Size of an Item allowed to be compressed

          Default

          size(1).mb()
          Copy

          Since

          9.0.0

    • logging: {
          debug: boolean;
          error: boolean;
          warn: boolean;
      }

      Various Logging-Related Settings

      Since

      7.4.0

      • debug: boolean

        Whether to enable DEBUG Logs

        Default

        false
        Copy

        Since

        7.4.0

      • error: boolean

        Whether to enable ERROR Logs

        Default

        true
        Copy

        Since

        7.4.0

      • warn: boolean

        Whether to enable WARN Logs

        Default

        true
        Copy

        Since

        7.4.0

    • methods: {
          head: boolean;
          trace: boolean;
      }

      The HTTP Methods that should automatically be handled for you

      Since

      9.5.0

      • head: boolean

        Whether to automatically handle HEAD Requests

        Default

        true
        Copy

        Since

        9.5.0

      • trace: boolean

        Whether to automatically handle TRACE Requests

        Default

        false
        Copy

        Since

        9.5.0

    • performance: {
          eTag: boolean;
          lastModified: boolean;
      }

      Various Performance-Related Settings

      Since

      6.3.0

      • eTag: boolean

        Whether to include ETag Headers on every request with a direct Body

        Default

        true
        Copy

        Since

        6.3.0

      • lastModified: boolean

        Whether to include Last-Modified Headers on every request that serves a file

        Default

        true
        Copy

        Since

        6.3.0

    • port: number

      The Port to use for the Server, can be random using 0

      Default

      0
      Copy

      Since

      0.0.1

    • proxy: {
          compress: boolean;
          credentials: {
              authenticate: boolean;
              password: string;
              username: string;
          };
          enabled: boolean;
          force: boolean;
          header: Lowercase<string>;
          ips: {
              list: (Subnet<4 | 6> | IPAddress<4 | 6>)[];
              mode: "whitelist" | "blacklist";
              validate: boolean;
          };
      }

      HTTP Proxy Options

      Since

      8.0.0

      • compress: boolean

        Whether to compress the requests

        Default

        false
        Copy

        Since

        9.0.0

      • credentials: {
            authenticate: boolean;
            password: string;
            username: string;
        }

        The Credentials that the proxy will use

        Since

        8.0.0

        • authenticate: boolean

          Whether to authenticate proxy requests

          Default

          false
          Copy

          Since

          8.0.0

        • password: string

          The Password required to authenticate

          Default

          "proxy"
          Copy

          Since

          8.0.0

        • username: string

          The Username required to authenticate

          Default

          "proxy"
          Copy

          Since

          8.0.0

      • enabled: boolean

        Whether to check for proxies and use alternate IPs

        Default

        false
        Copy

        Since

        8.0.0

      • force: boolean

        Whether to force all requests through the proxy

        Default

        false
        Copy

        Since

        8.0.0

      • header: Lowercase<string>

        The Header to use for getting the actual IP address, it must only include the IP address

        Default

        "x-forwarded-for"
        Copy

        Since

        8.0.0

      • ips: {
            list: (Subnet<4 | 6> | IPAddress<4 | 6>)[];
            mode: "whitelist" | "blacklist";
            validate: boolean;
        }

        The IPs the server will validate against

        Since

        9.0.0

        • list: (Subnet<4 | 6> | IPAddress<4 | 6>)[]

          The List of Authorized (or Unauthorized) Proxy IPs

          Default

          [...ReverseProxyIps.LOCAL, ...ReverseProxyIps.CLOUDFLARE]
          Copy

          Since

          9.0.0

        • mode: "whitelist" | "blacklist"

          The Mode in which to validate the list

          Default

          "whitelist"
          Copy

          Since

          9.0.0

        • validate: boolean

          Whether to validate proxy ips

          Default

          false
          Copy

          Since

          9.0.0

    • version: boolean

      Whether to add the rjweb-server header that contains the version

      Default

      true
      Copy

      Since

      9.0.0

  Returns Implementation

Readonly options

Abstract handle

• handle(handlers): void

• Parameters

  • handlers: {
        http: ((context) => Promise<any>);
        ws: ((context) => Promise<any>);
    }

    • http: ((context) => Promise<any>)

      • • (context): Promise<any>

        • Parameters

          • context: ImplementationHttpContext

          Returns Promise<any>

    • ws: ((context) => Promise<any>)

      • • (context): Promise<any>

        • Parameters

          • context: ImplementationWsContext

          Returns Promise<any>

  Returns void

Abstract name

• name(): string

• Returns string

Abstract port

• port(): number

• Returns number

Abstract start

• start(): Promise<void>

• Returns Promise<void>

Abstract stop

• stop(): void

• Returns void

Abstract version

• version(): string

• Returns string

Abstract wsPublish

• wsPublish(type, id, data, compressed): void

• Parameters

  • type: "binary" | "text"
  • id: number
  • data: ArrayBuffer
  • compressed: boolean

  Returns void