@types/http-server

  • Version 0.12.4
  • Published
  • 4.58 kB
  • 1 dependency
  • MIT license

Install

npm i @types/http-server
yarn add @types/http-server
pnpm add @types/http-server

Overview

TypeScript definitions for http-server

Index

Functions

function createServer

createServer: (options?: Options) => http.Server | https.Server;

    Interfaces

    interface Options

    interface Options {}

      property autoIndex

      autoIndex?: boolean | 'false' | undefined;

        property before

        before?: HandleFunction[] | undefined;

          property cache

          cache?: number | undefined;

            property contentType

            contentType?: string | undefined;

              property cors

              cors?: boolean | undefined;

                property corsHeaders

                corsHeaders?: string | undefined;

                  property ext

                  ext?: boolean | undefined;

                    property gzip

                    gzip?: boolean | undefined;

                      property headers

                      headers?: { [name: string]: string } | undefined;

                        property https

                        https?: https.ServerOptions | undefined;

                          property logFn

                          logFn?:
                          | ((req: http.IncomingMessage, res: http.ServerResponse, err: Error) => void)
                          | undefined;

                            property password

                            password?: string | undefined;

                              property proxy

                              proxy?: string | undefined;

                                property robots

                                robots?: string | true | undefined;

                                  property root

                                  root?: string | undefined;

                                    property showDir

                                    showDir?: boolean | 'false' | undefined;

                                      property showDotfiles

                                      showDotfiles?: boolean | undefined;

                                        property username

                                        username?: string | undefined;

                                          Package Files (1)

                                          Dependencies (1)

                                          Dev Dependencies (0)

                                          No dev dependencies.

                                          Peer Dependencies (0)

                                          No peer dependencies.

                                          Badge

                                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/http-server.

                                          • Markdown
                                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/http-server)
                                          • HTML
                                            <a href="https://www.jsdocs.io/package/@types/http-server"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>