Need help with serve-static?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

nestjs
155 Stars 19 Forks MIT License 510 Commits 2 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

Nest Logo

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

NPM Version Package License NPM Downloads Travis Linux Coverage Discord Backers on Open Collective Sponsors on Open Collective

<!--Backers on Open Collective Sponsors on Open Collective-->

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) | |
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

License

Nest is MIT licensed.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.