Skip to content

Commit

Permalink
feat: initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
morigs committed Jul 25, 2024
0 parents commit 0955f6a
Show file tree
Hide file tree
Showing 13 changed files with 922 additions and 0 deletions.
177 changes: 177 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore

dist/

# Logs

logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Caches

.cache

# Diagnostic reports (https://nodejs.org/api/report.html)

report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# Runtime data

pids
_.pid
_.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover

lib-cov

# Coverage directory used by tools like istanbul

coverage
*.lcov

# nyc test coverage

.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)

.grunt

# Bower dependency directory (https://bower.io/)

bower_components

# node-waf configuration

.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)

build/Release

# Dependency directories

node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)

web_modules/

# TypeScript cache

*.tsbuildinfo

# Optional npm cache directory

.npm

# Optional eslint cache

.eslintcache

# Optional stylelint cache

.stylelintcache

# Microbundle cache

.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history

.node_repl_history

# Output of 'npm pack'

*.tgz

# Yarn Integrity file

.yarn-integrity

# dotenv environment variable files

.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)

.parcel-cache

# Next.js build output

.next
out

# Nuxt.js build / generate output

.nuxt
dist

# Gatsby files

# Comment in the public line in if your project uses Gatsby and not Next.js

# https://nextjs.org/blog/next-9-1#public-directory-support

# public

# vuepress build output

.vuepress/dist

# vuepress v2.x temp and cache directory

.temp

# Docusaurus cache and generated files

.docusaurus

# Serverless directories

.serverless/

# FuseBox cache

.fusebox/

# DynamoDB Local files

.dynamodb/

# TernJS port file

.tern-port

# Stores VSCode versions used for testing VSCode extensions

.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# IntelliJ based IDEs
.idea

# Finder (MacOS) folder config
.DS_Store
25 changes: 25 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.git
.github
.gitignore
.prettierrc
.cjs.swcrc
.es.swcrc
bun.lockb

node_modules
tsconfig.json
pnpm-lock.yaml
jest.config.js
nodemon.json

tests
src
test
CHANGELOG.md
.eslintrc.js
tsconfig.cjs.json
tsconfig.esm.json
tsconfig.dts.json

build.ts
src
12 changes: 12 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"editor.formatOnSave": true,
"[javascript]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[typescript]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[json]": {
"editor.defaultFormatter": "biomejs.biome"
}
}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Igor Morozov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
109 changes: 109 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# elysia-accepts

Plugin for [Elysia](https://github.com/elysiajs/elysia) for content negotiation based on Accept headers based on `@tinyhttp/accepts` which is based on old good `negotiator`.

## Installation

```sh
bun a elysia-accepts
```

```ts
import { accepts } from "elysia-accepts";

const app = new Elysia()
.use(accepts());
```

No options currently available and plugin is always registered in global scope.

## Context

### Type

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.type("text/html")); // Returns "html" if acceptable
```

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.type(["text/html", "application/json"]));
// Returns the first acceptable or false if none
```

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.type(["html", "json"]));
// Can pass file extension. In this case "html" returned if acceptable.
```

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.types); // Returns the list of all acceptable encodings
```

### Encoding

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.encoding("gzip")); // Returns "gzip" if acceptable
```

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.encoding(["gzip", "deflate"])); // Returns the first acceptable or false if none
```

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.encodings); // Returns the list of all acceptable encodings
```

### Languages

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.language("en")); // Returns "en" if acceptable
```

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.language(["en", "ru"])); // Returns the first acceptable or false if none
```

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => ctx.languages); // Returns the list of all acceptable languages
```

## Guard

### Per Route

```ts
const app = new Elysia()
.use(accepts())
.get("/", (ctx) => 'hi', { types: ['text/plain'] });
// Returns 406 if plain text is not acceptable
```

### Global

```ts
const app = new Elysia()
.use(accepts())
.guard({ types: ['text/plain'] })
.get("/", (ctx) => 'hi');
// Returns 406 if plain text is not acceptable
```
28 changes: 28 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
},
"organizeImports": {
"enabled": true
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
}
},
"formatter": {
"indentStyle": "space",
"indentWidth": 2
},
"json": {
"formatter": {
"trailingCommas": "none",
"indentStyle": "space",
"indentWidth": 4
}
}
}
Loading

0 comments on commit 0955f6a

Please sign in to comment.