Variable install

Type Declaration

• • (server: any, options?: InstallOptions): boolean

  • Installs the header gate on a listening server, so each connection's header is read and taken off before the listener sees the connection.

    A no-op when global.proxyProtocol is off, so a listener module calls it unconditionally; idempotent per server.

    Parameters

    • server: any

      the net, tls or http server

    • Optionaloptions: InstallOptions

      label, the listener's name in logs and audit rows, and channel, the audit row's channel (tcp when absent)

    Returns boolean

    true when the gate is installed, false when the protocol is off