@7rulnik/nest-serve-static 中文文档教程

Question

[特拉维斯形象]：https://api.travis-ci.org/nestjs/nest.svg?branch=master [特拉维斯网址]：https://travis-ci.org/nestjs/nest [linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux [linux-url]: https://travis-ci.org/nestjs/nest

一个渐进的 Node.js 构建框架高效且可扩展的服务器端应用程序。

<p align="center">

Description

@7rulnik/nest-serve-static 用于 Nest 的包，可用于提供静态内容，如单页应用程序（温泉）。 但是，如果您正在构建 MVC 应用程序或想要提供资产文件（图像、文档），请使用 useStaticAssets() 方法（阅读更多 此处) 代替。

Installation

$ npm i --save @7rulnik/nest-serve-static

Example

请在此处查看完整示例。

Usage

只需在您的 Nest 应用程序中导入 ServeStaticModule。

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

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

API Spec

forRoot() 方法采用具有一些有用属性的选项对象。

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 是 MIT 许可的开源项目。 由于赞助商和惊人支持者的支持，它可以成长。 如果您想加入他们，请在此处阅读更多信息。

Stay in touch

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

License

Nest 已获得 MIT 许可。