@types/swagger-jsdoc - npm Package Compare versions

Comparing version 0.0.2 to 3.0.0

swagger-jsdoc/index.d.ts

		@@ -1,14 +0,16 @@
		// Type definitions for Swagger-JSDoc
		// Type definitions for swagger-jsdoc 3.0
		// Project: https://github.com/surnet/swagger-jsdoc
		// Definitions by: Daniel Grove <https://github.com/drGrove>
		// Neil Bryson Cargamento <https://github.com/neilbryson>
		// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
		// TypeScript Version: 2.2
		// TypeScript Version: 2.8

		/* =================== USAGE ===================

		import * as express from "express"
		import swaggerJSDoc = require('swagger-jsdoc');
		const app = express()
		import * as express from 'express';
		import swaggerJSDoc, { Options } from 'swagger-jsdoc';

		let options = {
		const app = express();

		const options: Options = {
		swaggerDefinition: {
		@@ -30,3 +32,3 @@ info: {

		var spec = swaggerJSDoc(options);
		const spec = swaggerJSDoc(options);

		@@ -40,5 +42,28 @@ app.get('/api-docs.json', function(req, res) {

		declare module "swagger-jsdoc" {
		function swaggerJSDoc(options?: any): any;
		export = swaggerJSDoc;
		export interface ApiInformation {
		description?: string;
		title: string;
		version: string;
		}

		export interface ServerInformation {
		url: string;
		[key: string]: any;
		}

		export interface SwaggerDefinition {
		basePath?: string;
		host?: string;
		info: ApiInformation;
		openapi?: string;
		servers?: ReadonlyArray<ServerInformation>;
		[key: string]: any;
		}

		export interface Options {
		apis?: ReadonlyArray<string>;
		swaggerDefinition: SwaggerDefinition;
		[key: string]: any;
		}

		export default function swaggerJSDoc(options?: Options): any;

swagger-jsdoc/package.json

		{
		"name": "@types/swagger-jsdoc",
		"version": "0.0.2",
		"description": "TypeScript definitions for Swagger-JSDoc",
		"version": "3.0.0",
		"description": "TypeScript definitions for swagger-jsdoc",
		"license": "MIT",
		@@ -11,13 +11,20 @@ "contributors": [
		"githubUsername": "drGrove"
		},
		{
		"name": "Neil Bryson Cargamento",
		"url": "https://github.com/neilbryson",
		"githubUsername": "neilbryson"
		}
		],
		"main": "",
		"types": "index",
		"repository": {
		"type": "git",
		"url": "https://www.github.com/DefinitelyTyped/DefinitelyTyped.git"
		"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
		"directory": "types/swagger-jsdoc"
		},
		"scripts": {},
		"dependencies": {},
		"typesPublisherContentHash": "d76315cfdaf5aad0118c28ce3d28802845df1583ec822fd55a4990fe795aa288",
		"typeScriptVersion": "2.2"
		"typesPublisherContentHash": "a0b654194b44345be29a781501c4e2fc5f72319f8167cb0593647d5f2c50ceea",
		"typeScriptVersion": "2.8"
		}

swagger-jsdoc/README.md

		@@ -5,9 +5,9 @@ # Installation
		# Summary
		This package contains type definitions for Swagger-JSDoc (https://github.com/surnet/swagger-jsdoc).
		This package contains type definitions for swagger-jsdoc (https://github.com/surnet/swagger-jsdoc).

		# Details
		Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/swagger-jsdoc
		Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/swagger-jsdoc

		Additional Details
		* Last updated: Thu, 09 Nov 2017 15:19:58 GMT
		* Last updated: Mon, 22 Jul 2019 19:44:31 GMT
		* Dependencies: none
		@@ -17,2 +17,2 @@ * Global values: none
		# Credits
		These definitions were written by Daniel Grove <https://github.com/drGrove>.
		These definitions were written by Daniel Grove <https://github.com/drGrove>, and Neil Bryson Cargamento <https://github.com/neilbryson>.

New alerts