|
| 1 | +--- |
| 2 | +description: | |
| 3 | + Quick reference for all public exports from Fresh's entry points: fresh, fresh/runtime, and fresh/dev. |
| 4 | +--- |
| 5 | + |
| 6 | +This page lists all public exports from Fresh's entry points. |
| 7 | + |
| 8 | +> [info]: You can also explore Fresh's full API documentation on JSR: |
| 9 | +> [`@fresh/core`](https://jsr.io/@fresh/core/doc) |
| 10 | +
|
| 11 | +## `fresh` |
| 12 | + |
| 13 | +The main entry point for server-side code. |
| 14 | + |
| 15 | +```ts |
| 16 | +import { App, createDefine, HttpError, page, staticFiles } from "fresh"; |
| 17 | +``` |
| 18 | + |
| 19 | +| Export | Kind | Description | |
| 20 | +| --------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------- | |
| 21 | +| [`App`](https://jsr.io/@fresh/core/doc/~/App) | Class | The main application class. See [App](/docs/concepts/app). | |
| 22 | +| [`staticFiles`](https://jsr.io/@fresh/core/doc/~/staticFiles) | Function | Middleware for serving static files. See [Static Files](/docs/concepts/static-files). | |
| 23 | +| [`createDefine`](https://jsr.io/@fresh/core/doc/~/createDefine) | Function | Create type-safe `define.*` helpers. See [Define Helpers](/docs/advanced/define). | |
| 24 | +| [`page`](https://jsr.io/@fresh/core/doc/~/page) | Function | Return data from a handler to a page component. See [Data Fetching](/docs/concepts/data-fetching). | |
| 25 | +| [`HttpError`](https://jsr.io/@fresh/core/doc/~/HttpError) | Class | Throw HTTP errors with status codes. See [Error Handling](/docs/advanced/error-handling). | |
| 26 | +| [`cors`](https://jsr.io/@fresh/core/doc/~/cors) | Function | CORS middleware. See [cors](/docs/plugins/cors). | |
| 27 | +| [`csrf`](https://jsr.io/@fresh/core/doc/~/csrf) | Function | CSRF protection middleware. See [csrf](/docs/plugins/csrf). | |
| 28 | +| [`csp`](https://jsr.io/@fresh/core/doc/~/csp) | Function | Content Security Policy middleware. See [csp](/docs/plugins/csp). | |
| 29 | +| [`trailingSlashes`](https://jsr.io/@fresh/core/doc/~/trailingSlashes) | Function | Trailing slash enforcement middleware. See [trailingSlashes](/docs/plugins/trailing-slashes). | |
| 30 | + |
| 31 | +**Types:** |
| 32 | + |
| 33 | +| Export | Kind | Description | |
| 34 | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------- | --------------------------------------------------------------------------- | |
| 35 | +| [`Context`](https://jsr.io/@fresh/core/doc/~/Context) / [`FreshContext`](https://jsr.io/@fresh/core/doc/~/FreshContext) | Interface | The request context passed to all middlewares and handlers. | |
| 36 | +| [`PageProps`](https://jsr.io/@fresh/core/doc/~/PageProps) | Type | Props received by page components (`data`, `url`, `params`, `state`, etc.). | |
| 37 | +| [`Middleware`](https://jsr.io/@fresh/core/doc/~/Middleware) / [`MiddlewareFn`](https://jsr.io/@fresh/core/doc/~/MiddlewareFn) | Type | Middleware function type. | |
| 38 | +| [`HandlerFn`](https://jsr.io/@fresh/core/doc/~/HandlerFn) | Type | Single handler function type. | |
| 39 | +| [`HandlerByMethod`](https://jsr.io/@fresh/core/doc/~/HandlerByMethod) | Type | Object with per-method handler functions. | |
| 40 | +| [`RouteHandler`](https://jsr.io/@fresh/core/doc/~/RouteHandler) | Type | Union of `HandlerFn` and `HandlerByMethod`. | |
| 41 | +| [`PageResponse`](https://jsr.io/@fresh/core/doc/~/PageResponse) | Type | Return type of `page()`. | |
| 42 | +| [`RouteConfig`](https://jsr.io/@fresh/core/doc/~/RouteConfig) | Interface | Route configuration (`routeOverride`, `skipInheritedLayouts`, etc.). | |
| 43 | +| [`LayoutConfig`](https://jsr.io/@fresh/core/doc/~/LayoutConfig) | Interface | Layout configuration (`skipInheritedLayouts`, `skipAppWrapper`). | |
| 44 | +| [`Define`](https://jsr.io/@fresh/core/doc/~/Define) | Interface | Type of the object returned by `createDefine()`. | |
| 45 | +| [`FreshConfig`](https://jsr.io/@fresh/core/doc/~/FreshConfig) / [`ResolvedFreshConfig`](https://jsr.io/@fresh/core/doc/~/ResolvedFreshConfig) | Interface | App configuration types. | |
| 46 | +| [`ListenOptions`](https://jsr.io/@fresh/core/doc/~/ListenOptions) | Interface | Options for `app.listen()`. | |
| 47 | +| [`Island`](https://jsr.io/@fresh/core/doc/~/Island) | Type | Island component type. | |
| 48 | +| [`Method`](https://jsr.io/@fresh/core/doc/~/Method) | Type | HTTP method union type. | |
| 49 | +| [`RouteData`](https://jsr.io/@fresh/core/doc/~/RouteData) | Type | Data type returned by route handlers via `page()`. | |
| 50 | +| [`Lazy`](https://jsr.io/@fresh/core/doc/~/Lazy) / [`MaybeLazy`](https://jsr.io/@fresh/core/doc/~/MaybeLazy) | Type | Utility types for lazily-loaded routes and middleware. | |
| 51 | +| [`CORSOptions`](https://jsr.io/@fresh/core/doc/~/CORSOptions) | Interface | Options for `cors()`. | |
| 52 | +| [`CsrfOptions`](https://jsr.io/@fresh/core/doc/~/CsrfOptions) | Interface | Options for `csrf()`. | |
| 53 | +| [`CSPOptions`](https://jsr.io/@fresh/core/doc/~/CSPOptions) | Interface | Options for `csp()`. | |
| 54 | + |
| 55 | +## `fresh/runtime` |
| 56 | + |
| 57 | +Shared runtime utilities for both server and client code. Safe to import in |
| 58 | +[islands](/docs/concepts/islands). |
| 59 | + |
| 60 | +```ts |
| 61 | +import { |
| 62 | + asset, |
| 63 | + assetSrcSet, |
| 64 | + Head, |
| 65 | + HttpError, |
| 66 | + IS_BROWSER, |
| 67 | + Partial, |
| 68 | +} from "fresh/runtime"; |
| 69 | +``` |
| 70 | + |
| 71 | +| Export | Kind | Description | |
| 72 | +| --------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------- | |
| 73 | +| [`IS_BROWSER`](https://jsr.io/@fresh/core/doc/runtime/~/IS_BROWSER) | Constant | `true` in the browser, `false` on the server. Use to guard browser-only code. | |
| 74 | +| [`asset`](https://jsr.io/@fresh/core/doc/runtime/~/asset) | Function | Add cache-busting query params to asset URLs. See [Static Files](/docs/concepts/static-files). | |
| 75 | +| [`assetSrcSet`](https://jsr.io/@fresh/core/doc/runtime/~/assetSrcSet) | Function | Apply `asset()` to all URLs in a `srcset` string. | |
| 76 | +| [`Partial`](https://jsr.io/@fresh/core/doc/runtime/~/Partial) | Component | Mark a region for partial updates. See [Partials](/docs/advanced/partials). | |
| 77 | +| [`Head`](https://jsr.io/@fresh/core/doc/runtime/~/Head) | Component | Add elements to the document `<head>`. See [<head> element](/docs/advanced/head). | |
| 78 | +| [`HttpError`](https://jsr.io/@fresh/core/doc/runtime/~/HttpError) | Class | HTTP error class (re-exported from `fresh`). | |
| 79 | + |
| 80 | +## `fresh/dev` |
| 81 | + |
| 82 | +Development and build tools. Only used in `dev.ts` (legacy) or build scripts. |
| 83 | + |
| 84 | +```ts |
| 85 | +import { Builder } from "fresh/dev"; |
| 86 | +``` |
| 87 | + |
| 88 | +| Export | Kind | Description | |
| 89 | +| --------------------------------------------------------- | ----- | ---------------------------------------------------------------------- | |
| 90 | +| [`Builder`](https://jsr.io/@fresh/core/doc/dev/~/Builder) | Class | Pre-Vite build system (legacy). See [Builder](/docs/advanced/builder). | |
| 91 | + |
| 92 | +**Types:** |
| 93 | + |
| 94 | +| Export | Kind | Description | |
| 95 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------------------------- | |
| 96 | +| [`BuildOptions`](https://jsr.io/@fresh/core/doc/dev/~/BuildOptions) | Interface | Options for `new Builder()`. | |
| 97 | +| [`ResolvedBuildConfig`](https://jsr.io/@fresh/core/doc/dev/~/ResolvedBuildConfig) | Interface | Resolved build configuration. | |
| 98 | +| [`OnTransformArgs`](https://jsr.io/@fresh/core/doc/dev/~/OnTransformArgs) / [`OnTransformOptions`](https://jsr.io/@fresh/core/doc/dev/~/OnTransformOptions) / [`TransformFn`](https://jsr.io/@fresh/core/doc/dev/~/TransformFn) | Type | Build plugin hook types. | |
0 commit comments