@types/express-sslify - npm Package Compare versions

Comparing version 1.2.1 to 1.2.2

express-sslify/index.d.ts

@@ -16,3 +16,3 @@ // Type definitions for express-sslify 1.2
      */
-    trustProtoHeader?: boolean;
+    trustProtoHeader?: boolean | undefined;
 
@@ -24,3 +24,3 @@ /**
      */
-    trustAzureHeader?: boolean;
+    trustAzureHeader?: boolean | undefined;
 
@@ -31,5 +31,5 @@ /**
      */
-    trustXForwardedHostHeader?: boolean;
+    trustXForwardedHostHeader?: boolean | undefined;
 }
 
 export function HTTPS(options?: Options): RequestHandler;

express-sslify/LICENSE

     MIT License
 
-    Copyright (c) Microsoft Corporation. All rights reserved.
+    Copyright (c) Microsoft Corporation.
 
@@ -5,0 +5,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy

express-sslify/package.json

 {
     "name": "@types/express-sslify",
-    "version": "1.2.1",
+    "version": "1.2.2",
     "description": "TypeScript definitions for express-sslify",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-sslify",
     "license": "MIT",
@@ -14,3 +15,3 @@ "contributors": [
     "main": "",
-    "types": "index",
+    "types": "index.d.ts",
     "repository": {
@@ -25,4 +26,4 @@ "type": "git",
     },
-    "typesPublisherContentHash": "d4670e80e7716ab42d0afcb9d36ad36bde5f6cf24d4014b26edba6fcace3dd57",
-    "typeScriptVersion": "2.3"
+    "typesPublisherContentHash": "9b11480ac8922e0172c922ab98d3a293ee61f3faee862feac05c0d654556dcef",
+    "typeScriptVersion": "3.6"
 }

express-sslify/README.md

@@ -8,10 +8,46 @@ # Installation
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-sslify
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-sslify.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-sslify/index.d.ts)
+````ts
+// Type definitions for express-sslify 1.2
+// Project: https://github.com/florianheinemann/express-sslify
+// Definitions by: Ben Grynhaus <https://github.com/bengry>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.3
 
-Additional Details
- * Last updated: Mon, 19 Aug 2019 00:51:15 GMT
- * Dependencies: @types/express
+import { RequestHandler } from 'express';
+
+export interface Options {
+    /**
+     * Heroku, nodejitsu and other hosters often use reverse proxies which offer SSL endpoints but then forward unencrypted HTTP traffic to the website.
+     * This makes it difficult to detect if the original request was indeed via HTTPS.
+     * Luckily, most reverse proxies set the x-forwarded-proto header flag with the original request scheme.
+     * @default false
+     */
+    trustProtoHeader?: boolean | undefined;
+
+    /**
+     * Azure has a slightly different way of signaling encrypted connections.
+     * To tell express-sslify to look out for Azure's x-arr-ssl header.
+     * @default false
+     */
+    trustAzureHeader?: boolean | undefined;
+
+    /**
+     * If your reverse proxy sends the original host using the X-Forwarded-Host header and you need to use that instead of the Host header for the redirect.
+     * @default false
+     */
+    trustXForwardedHostHeader?: boolean | undefined;
+}
+
+export function HTTPS(options?: Options): RequestHandler;
+
+````
+
+### Additional Details
+ * Last updated: Thu, 08 Jul 2021 12:01:23 GMT
+ * Dependencies: [@types/express](https://npmjs.com/package/@types/express)
  * Global values: none
 
 # Credits
-These definitions were written by Ben Grynhaus <https://github.com/bengry>.
+These definitions were written by [Ben Grynhaus](https://github.com/bengry).

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5303

42.67%

Number of low quality alerts

0

-100%

Number of lines in readme file

53

211.76%

No dependency changes