JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 243344
  • Score
    100M100P100Q168444F
  • License MIT

Check if the given request is HTTPS

Package Exports

  • is-https

Readme

is-https

Check if the given request is HTTPS

npm npm (scoped with tag)

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.

License

MIT