From 3aec4e16b28c0cec1121f1acbe402df15e5a873f Mon Sep 17 00:00:00 2001 From: Andy Date: Mon, 23 Oct 2017 11:12:47 -0700 Subject: [PATCH] restify-cors-middleware: Fix lint (#20914) --- types/restify-cors-middleware/index.d.ts | 25 ++++++++++-------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/types/restify-cors-middleware/index.d.ts b/types/restify-cors-middleware/index.d.ts index d7b92d25a9..09588d1da9 100644 --- a/types/restify-cors-middleware/index.d.ts +++ b/types/restify-cors-middleware/index.d.ts @@ -10,11 +10,20 @@ import { RequestHandler } from 'restify'; declare namespace corsMiddleware { interface Options { - origins: string[]; + /** + * an array of whitelisted origins + * can be both strings and regular expressions + */ + origins: Array; + /** user defined headers to allow */ allowHeaders: string[]; + /** user defined headers to expose */ exposeHeaders: string[]; + /** if true, uses creds */ credentials?: boolean; + /** ms to cache preflight requests */ preflightMaxAge?: number; + /** customize preflight request handling */ preflightStrategy?: any; } @@ -24,19 +33,5 @@ declare namespace corsMiddleware { } } -/** - * @public - * @param {Object} options an options object - * @param {Array} [options.origins] an array of whitelisted origins, can be - * both strings and regular expressions - * @param {Boolean} [options.credentials] if true, uses creds - * @param {Array} [options.allowHeaders] user defined headers to allow - * @param {Array} [options.exposeHeaders] user defined headers to expose - * @param {Number} [options.preflightMaxAge] ms to cache preflight requests - * @param {Object | Function} [options.preflightStrategy] - * customize preflight request handling - * @returns {Object} returns an object with actual and preflight handlers - */ declare function corsMiddleware(options: corsMiddleware.Options): corsMiddleware.CorsMiddleware; - export = corsMiddleware;