@types/serve-static

What is @types/serve-static?

The @types/serve-static package contains TypeScript type definitions for the serve-static middleware, which is used with Node.js HTTP servers to serve static files. These type definitions allow TypeScript developers to use serve-static in a type-safe manner, ensuring that they use the correct types for function arguments, return types, and object properties.

What are @types/serve-static's main functionalities?

Serve static files

This code sample demonstrates how to use serve-static with Express to serve static files from the 'public' directory. It also specifies that 'index.html' or 'index.htm' should be used as the default file to serve if a directory is requested.

import * as express from 'express';
import * as serveStatic from 'serve-static';

const app = express();

app.use(serveStatic('public', {'index': ['index.html', 'index.htm']}));

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Other packages similar to @types/serve-static

express

Express is a web application framework for Node.js, designed for building web applications and APIs. It is often used in conjunction with serve-static to serve static files, but it also provides a wide range of other features such as routing, middleware, template engines, and more.

koa-static

Koa-static is similar to serve-static but is designed for use with Koa, another web framework for Node.js. It provides similar functionality for serving static files in Koa applications.

connect-static

Connect-static is a middleware for Connect, which is an extensible HTTP server framework for Node.js and is used as the foundation for Express. It provides static file serving capabilities similar to serve-static.

README

Installation

npm install --save @types/serve-static

Summary

This package contains type definitions for serve-static (https://github.com/expressjs/serve-static).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/serve-static.

Additional Details

• Last updated: Wed, 03 Apr 2024 06:07:52 GMT
• Dependencies: @types/http-errors, @types/node, @types/send

Credits

These definitions were written by Uros Smolnik, Linus Unnebäck, and Devansh Jethmalani.