Installation
npm install --save @types/koa-sslify
Summary
This package contains type definitions for koa-sslify (https://github.com/turboMaCk/koa-sslify#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-sslify.
index.d.ts
import koa = require("koa");
export interface Options {
/**
* Function used to test if request is secure
*/
resolver?: ((ctx: koa.Context) => boolean) | undefined;
/**
* Hostname for redirect (uses request host if not set)
*/
hostname?: string | undefined;
/**
* Port of HTTPS server
*/
port?: number | undefined;
/**
* Avoid :443 port in redirect url
*/
skipDefaultPort?: boolean | undefined;
/**
* Ignore url path (redirect to domain)
*/
ignoreUrl?: boolean | undefined;
/**
* Temporary mode (use 307 Temporary Redirect)
*/
temporary?: boolean | undefined;
/**
* Whitelist methods that should be redirected
*/
redirectMethods?: string[] | undefined;
/**
* Status returned for disallowed methods
*/
disallowStatus?: number | undefined;
}
/**
* Default HTTPS resolver
* This works when using node.js TLS support
*/
export function httpsResolver(ctx: koa.Context): boolean;
/**
* x-forwarded-proto header resolver
* common for heroku gcp (ingress) etc
*/
export function xForwardedProtoResolver(ctx: koa.Context): boolean;
/**
* Azure resolver
* Azure is using `x-att-ssl` header
*/
export function azureResolver(ctx: koa.Context): boolean;
/**
* Custom proto header factory
*/
export function customProtoHeaderResolver(header: string): (ctx: koa.Context) => boolean;
/**
* Resolver for `Forwarded` header
* see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Forwarded
*/
export function forwardedResolver(ctx: koa.Context): boolean;
export default function factory(options?: Options): koa.Middleware;
Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:38 GMT
- Dependencies: @types/koa
Credits
These definitions were written by Matthew Bull, and Mihkel Sokk.