Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/stoppable) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Installation
npm install --save @types/stoppable
Summary
This package contains type definitions for stoppable (https://github.com/hunterloftis/stoppable).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stoppable.
index.d.ts
/// <reference types="node" />
import * as http from "http";
import * as https from "https";
declare namespace stoppable {
// Left for backwards compatibility
type StoppableServer = http.Server & WithStop;
interface WithStop {
/**
* Closes the server.
*
* @param callback Passed along to the existing `server.close` function to
* auto-register a `'close'` event. The first agrument is an error, and
* the second argument indicates whether it stopped gracefully.
*/
stop(callback?: (e: Error | undefined, gracefully: boolean) => any): void;
}
}
/**
* Decorates a server instance with a `stop` method.
*
* @param server Any HTTP or HTTPS Server instance.
* @param grace Milliseconds to wait before force-closing connections. Defaults to
* `Infinity` (don't force-close). If you want to immediately kill all sockets
* you can use a grace of `0`.
* @returns The server instance, so can be chained, or can be run as a standalone statement.
*
* @example
* import * as http from 'http';
* import stoppable = require('stoppable');
*
* const server = stoppable(http.createServer((req, res) => {}));
* server.stop();
*/
declare function stoppable<T extends http.Server | https.Server>(server: T, grace?: number): T & stoppable.WithStop;
export = stoppable;
Additional Details
- Last updated: Tue, 07 Nov 2023 15:11:36 GMT
- Dependencies: @types/node
Credits
These definitions were written by Eric Byers, John Plusjé, and BendingBender.