Fresh 文档

本页列出了 Fresh 入口点的所有公共导出。

[info]: 您也可以在 JSR 上探索 Fresh 的完整 API 文档： @fresh/core

`fresh`

服务器端代码的主要入口点。

import { App, createDefine, HttpError, page, staticFiles } from "fresh";

导出	类型	描述
`App`	类	主要应用类。参见 App。
`staticFiles`	函数	用于服务静态文件的中间件。参见静态文件。
`createDefine`	函数	创建类型安全的 `define.*` 辅助函数。参见 Define 辅助函数。
`page`	函数	从处理器向页面组件返回数据。参见数据获取。
`HttpError`	类	抛出带状态码的 HTTP 错误。参见错误处理。
`cors`	函数	CORS 中间件。参见 cors。
`csrf`	函数	CSRF 保护中间件。参见 csrf。
`csp`	函数	内容安全策略中间件。参见 csp。
`trailingSlashes`	函数	尾部斜杠强制中间件。参见 trailingSlashes。

类型：

导出	类型	描述
`Context` / `FreshContext`	接口	传递给所有中间件和处理器的请求上下文。
`PageProps`	类型	页面组件接收的属性（`data`、`url`、`params`、`state` 等）。
`Middleware` / `MiddlewareFn`	类型	中间件函数类型。
`HandlerFn`	类型	单个处理器函数类型。
`HandlerByMethod`	类型	包含按方法分的处理器函数的对象。
`RouteHandler`	类型	`HandlerFn` 和 `HandlerByMethod` 的联合类型。
`PageResponse`	类型	`page()` 的返回类型。
`RouteConfig`	接口	路由配置（`routeOverride`、`skipInheritedLayouts` 等）。
`LayoutConfig`	接口	布局配置（`skipInheritedLayouts`、`skipAppWrapper`）。
`Define`	接口	`createDefine()` 返回的对象类型。
`FreshConfig` / `ResolvedFreshConfig`	接口	应用配置类型。
`ListenOptions`	接口	`app.listen()` 的选项。
`Island`	类型	Island 组件类型。
`Method`	类型	HTTP 方法联合类型。
`RouteData`	类型	路由处理器通过 `page()` 返回的数据类型。
`Lazy` / `MaybeLazy`	类型	用于延迟加载路由和中间件的实用类型。
`CORSOptions`	接口	`cors()` 的选项。
`CsrfOptions`	接口	`csrf()` 的选项。
`CSPOptions`	接口	`csp()` 的选项。

服务器和客户端代码共享的运行时工具。在 islands 中导入是安全的。

import {
  asset,
  assetSrcSet,
  Head,
  HttpError,
  IS_BROWSER,
  Partial,
} from "fresh/runtime";

导出	类型	描述
`IS_BROWSER`	常量	在浏览器中为 `true`，在服务器上为 `false`。用于保护仅浏览器代码。
`asset`	函数	向资源 URL 添加缓存破坏查询参数。参见静态文件。
`assetSrcSet`	函数	对 `srcset` 字符串中的所有 URL 应用 `asset()`。
`Partial`	组件	标记一个区域用于部分更新。参见部分更新。
`Head`	组件	向文档 `<head>` 添加元素。参见 <head> 元素。
`HttpError`	类	HTTP 错误类（从 `fresh` 重新导出）。

开发和构建工具。仅在 dev.ts（遗留）或构建脚本中使用。

import { Builder } from "fresh/dev";

导出	类型	描述
`Builder`	类	Pre-Vite 构建系统（遗留）。参见 Builder。

类型：

导出	类型	描述
`BuildOptions`	接口	`new Builder()` 的选项。
`ResolvedBuildConfig`	接口	解析后的构建配置。
`OnTransformArgs` / `OnTransformOptions` / `TransformFn`	类型	构建插件钩子类型。