https://github.com/oakserver/commons
A set of APIs for handling HTTP and HTTPS requests with Deno 🐿️ 🦕
https://github.com/oakserver/commons
Last synced: 10 months ago
JSON representation
A set of APIs for handling HTTP and HTTPS requests with Deno 🐿️ 🦕
- Host: GitHub
- URL: https://github.com/oakserver/commons
- Owner: oakserver
- Created: 2021-12-30T01:11:14.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-05T00:04:49.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T14:59:20.249Z (almost 2 years ago)
- Language: TypeScript
- Homepage: https://deno.land/x/oak_commons
- Size: 91.8 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# oak commons
[](https://jsr.io/@oak/commons)
[](https://jsr.io/@oak/commons)
[](https://deno.land/x/oak_commons)
[](https://github.com/oakserver/commons)
[](https://codecov.io/gh/oakserver/commons)
A set of APIs that are common to HTTP/HTTPS servers.
> [!NOTE]
> Originally most of this code was contributed to the Deno standard library but
> the maintainers after accepting the contributions have moved to remove this
> code, so I had to resurrect this library to be able to provide common HTTP
> functionality.
Each module is designed to be largely independent of other modules, with as few
shared dependencies as reasonable. These modules are designed as building blocks
for more complex HTTP/HTTPS and server frameworks.
The [acorn](https://deno.land/x/acorn) (a RESTful services framework) and
[oak](https://jsr.io/@oak/oak) are examples of something built on top of
oak commons.
## Usage
Each module/export is designed to be as independent as possible and there is no
top level export, so each area of functionality needs to be imported. For
example, to use `status` would look something like this:
```ts
import { STATUS_CODE, STATUS_TEXT } from "jsr:@oak/commons/status";
console.log(STATUS_CODE.NotFound); // Returns 404
console.log(STATUS_TEXT[STATUS_CODE.NotFound]); // Returns "Not Found"
```
## Documentation
The
[inline documentation](https://jsr.io/@oak/commons)
for each modules is the best guide on the usage of the APIs:
- [/assert](https://jsr.io/@oak/commons/doc/cookie_map/~) - an assertion
function that throws HTTP errors when the assertion fails.
- [/cookie_map](https://jsr.io/@oak/commons/doc/cookie_map/~) - an API for
managing signed and unsigned cookies server side.
- [/form_data](https://jsr.io/@oak/commons/doc/form_data/~) - the ability to
parse a stream body into `FormData` when this functionality isn't available
in the runtime.
- [/forwarded](https://jsr.io/@oak/commons/doc/forwarded/~) - a parser for
the `Forwarded` header vale.
- [/http_errors](https://jsr.io/@oak/commons/doc/http_errors/~) - utilities
for working with HTTP Error status as JavaScript errors.
- [/keystack](https://jsr.io/@oak/commons/doc/keystack/~) - a key ring
implementation to allow for management of rotating encryption keys.
- [/media_types](https://jsr.io/@oak/commons/doc/media_types/~) - utilities
for working with media types from a request.
- [/method](https://jsr.io/@oak/commons/doc/method/~) - utilities for working
with HTTP methods/verbs in a type safe way.
- [/range](https://jsr.io/@oak/commons/doc/range/~) - utilities for
supporting range requests.
- [/server_sent_event](https://jsr.io/@oak/commons/doc/server_sent_event/~) -
an abstraction for managing server sent events like DOM events.
- [/status](https://jsr.io/@oak/commons/doc/status/~) - utilities for working
with HTTP statuses in a type safe way.
---
Copyright 2018 - 2024 the oak authors. All rights reserved. MIT License.