@nestjs/serve-static — Serve static websites… · nestjs.io

serve-static

Well Maintained

nestjs/serve-static

Serve static websites (SPA's) using Nest framework (node.js) 🥦

GitHub Website

Frontend & Serving

javascript nestjs node node-framework nodejs serve-static typescript

README

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

This package ships as ES modules only and requires Node.js ^20.19.0 || ^22.12.0 || >=23.0.0.

CommonJS applications can still consume it through Node's require(esm) support. TypeScript projects that compile to CommonJS need "module": "nodenext" in their tsconfig.json; the older "node16" setting predates require(esm) and reports TS1479.

Example

See full example here.

Usage

GitHub Stats

Stars515

Forks65

Open Issues6

Security

No known vulnerabilities

Downloads

Weekly697.9k/week

Total2.9M total

Used By

Used by 5 tracked packages

ghostfolio9.2k stars amplication16.0k stars ultimate-nest438 stars truthy600 stars stator300 stars

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

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

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[] / RegExp	Paths to exclude when serving the static app, given either as an array of path patterns or as a single `RegExp` matched against the request path. 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)
`useGlobalPrefix`	boolean	If `true`, static app will be prefixed by the global prefix set through `setGlobalPrefix()`. Default: `false` https://docs.nestjs.com/faq/global-prefix

serve-static

README

Description

Installation

Example

Usage

GitHub Stats

Security

Downloads

Used By

API Spec

Support

Stay in touch

License

Details

Health Status