Installations

npm install @nestjs/serve-static

Pull Requests

Open

7

Total

1,484

Closed

48

Merged

1,429

Issues

Open

10

Total

47

Closed

37

Releases

12

Release 4.0.2

4.0.2

Published on 29 Mar 2024

Release 4.0.1

4.0.1

Published on 07 Feb 2024

Release 4.0.0

4.0.0

Published on 15 Jun 2023

Release 3.0.1

3.0.1

Published on 09 Feb 2023

Release 3.0.0

3.0.0

Published on 08 Jul 2022

Release 2.2.2

2.2.2

Published on 07 Jul 2021

View all 12 releases

Developer

nestjs

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

Typescript Support

Yes

Node Version

16.20.0

NPM Version

8.19.4 Statistics

464 Stars

1,614 Commits

60 Forks

6 Watching

7 Branches

19 Contributors

Updated on 28 Nov 2024

Languages

TypeScript (93.29%)

JavaScript (5.67%)

Shell (1.04%)

Total Downloads

Cumulative downloads

Total Downloads

32,585,648

Last day

0.1%

59,161

Compared to previous day

Last week

3.5%

327,758

Compared to previous week

Last month

12.1%

1,363,456

Compared to previous month

Last year

95.3%

16,352,351

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

path-to-regexp

Peer Dependencies

5

@nestjs/common @nestjs/core express fastify @fastify/static

Dev Dependencies

20

Versions

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

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

Example

See full example here.

Usage

Simply import ServeStaticModule in your Nest application.

1import { Module } from '@nestjs/common';
2import { join } from 'path';
3import { ServeStaticModule } from '@nestjs/serve-static';
4
5@Module({
6  imports: [
7    ServeStaticModule.forRoot({
8      rootPath: join(__dirname, '..', 'client')
9    })
10  ]
11})
12export 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.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Maintained

Determines if the project is "actively maintained".

10

License

Determines if the project has defined a license.

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More