unjs / is-https

Check if the given request is HTTPS

is-https

Check if the given request is HTTPS

Usage

Install package:

yarn add is-https
# or
npm install is-https

const isHTTPS = require('is-https')
// or
import isHTTPS from 'is-https'

function isHTTPS(req: IncomingMessage, trustProxy: Boolean = true): Boolean | undefined

Behaviour

isHTTPS function tries to use 2 different methods for HTTPS detection:

• Test if x-forwarded-proto header contains https
  • Can be disabled by setting trustProxy argument to false
• Test if req.connection.encrypted is true

Returns either true or false based on checks or undefined if no check was reliable.

TIP: If you want to redirect users from http to https, it is better using isHTTPS(req) === false to avoid redirect loops.

Related

• redirect-ssl - Connect middleware to enforce HTTPS

License

MIT