is-https
v4.0.0
Published
Check if the given request is HTTPS
Downloads
1,356,101
Readme
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 containshttps
- Can be disabled by setting
trustProxy
argument tofalse
- Can be disabled by setting
- Test if
req.connection.encrypted
istrue
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