https://github.com/bogeychan/elysia-etag

A plugin for Elysia.js for automatic HTTP ETag generation
https://github.com/bogeychan/elysia-etag

elysia etag

Last synced: 3 months ago
JSON representation

A plugin for Elysia.js for automatic HTTP ETag generation

• Host: GitHub
• URL: https://github.com/bogeychan/elysia-etag
• Owner: bogeychan
• License: mit
• Created: 2023-09-09T22:35:15.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-09T11:41:47.000Z (9 months ago)
• Last Synced: 2024-05-03T12:28:22.268Z (6 months ago)
• Topics: elysia, etag
• Language: TypeScript
• Homepage: https://npmjs.com/package/@bogeychan/elysia-etag
• Size: 35.2 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-elysia - ETag - Automatic HTTP ETags generation. (Plugins)

README

        
# @bogeychan/elysia-etag

A plugin for [Elysia.js](https://elysiajs.com) for automatic [HTTP ETag](https://http.dev/etag) generation

## Installation

```bash

bun add @bogeychan/elysia-etag

```

## Usage

```ts

import { Elysia } from 'elysia'

import { etag } from '@bogeychan/elysia-etag'

const app = new Elysia()

	.use(etag())

	.get('/', () => 'Checkout the response headers!')

	.get('/custom-etag', (ctx) => {

		// This line disables automatic ETag generation

		// It will still return a 304 - Not Modified - status code if the ETag matches

		ctx.setETag('"myETag"')

		return 'Hello ETag!'

	})

	.listen(8080)

console.log(`Listening on ${app.server!.url}`)

```

Checkout the [examples](./examples) folder on github for further use cases.

## Credits ❤️

This project was inspired by [@fastify/etag](https://www.npmjs.com/package/@fastify/etag)

## Author

[bogeychan](https://github.com/bogeychan)

## License

[MIT](LICENSE)