Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the error thrown by send on no FS match #332

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -866,6 +866,45 @@ app.use(async (context, next) => {
await app.listen({ port: 8000 });
```

When `send()` can't find a matching filesystem entry, it will throw an
`HttpError` with its status set to `404` (`Status.NotFound`). This example
illustrates handling that error in order to use another middleware (a fallback
virtual filesystem) when `send()` can't find a match:

```ts
import {
Application,
HttpError,
Router,
Status,
} from "https://deno.land/x/oak/mod.ts";

const fallbackFilesystem = new Router()
.get("/virtual_file.txt", (context) => {
context.response.body = "Hello world";
});

const app = new Application()
.use(async (context, next) => {
try {
await context.send({
root: `${Deno.cwd()}/examples/static`,
index: "index.html",
});
} catch (ex) {
if (ex instanceof HttpError && ex.status === Status.NotFound) {
// send didn't find a matching filesystem entry
return next();
}
throw ex;
}
})
.use(fallbackFilesystem.routes())
.use(fallbackFilesystem.allowedMethods());

await app.listen({ port: 8000 });
```

`send()` automatically supports features like providing `ETag` and
`Last-Modified` headers in the response as well as processing `If-None-Match`
and `If-Modified-Since` headers in the request. This means when serving up
Expand Down