@nestjs/serve-static

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

@nestjs/serve-static package for Nest, useful to serve static content like Single Page Applications (SPA). However, if you are building MVC application or want to serve assets files (images, docs), use the useStaticAssets() method (read more here) instead.

Installation

$ npm i --save @nestjs/serve-static

Example

See full example here.

Usage

Simply import ServeStaticModule in your Nest application.

import { Module } from '@nestjs/common';
import { join } from 'path';
import { ServeStaticModule } from '@nestjs/serve-static';

@Module({
  imports: [
    ServeStaticModule.forRoot({
      rootPath: join(__dirname, '..', 'client')
    })
  ]
})
export class ApplicationModule {}

API Spec

The forRoot() method takes an options object with a few useful properties.

Property	Type	Description
rootPath	string	Static files root directory. Default: "client"
serveRoot	string	Root path under which static app will be served. Default: ""
renderPath	string / RegExp	Path to render static app (concatenated with the serveRoot value). Default: * (wildcard - all paths). Note: RegExp is not supported by the @nestjs/platform-fastify.
exclude	string[]	Paths to exclude when serving the static app. WARNING! Not supported by fastify. If you use fastify, you can exclude routes using regexp (set the renderPath to a regular expression) instead.
serveStaticOptions	Object	Serve static options (static files)

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.

Similar packages

Other packages similar to @nestjs/serve-static

express-static

The 'express-static' middleware is used in Express.js applications to serve static files. It is similar to @nestjs/serve-static but is designed for use with Express.js rather than NestJS. It provides similar functionality for serving static assets.

koa-static

The 'koa-static' middleware is used in Koa.js applications to serve static files. Like @nestjs/serve-static, it allows you to serve static assets, but it is designed for use with the Koa.js framework.

fastify-static

The 'fastify-static' plugin is used in Fastify applications to serve static files. It provides similar functionality to @nestjs/serve-static but is tailored for the Fastify framework, offering high performance and low overhead.