Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elysiajs/elysia-cookie
A plugin for Elysia that add supports for get/set cookie
https://github.com/elysiajs/elysia-cookie
Last synced: 11 days ago
JSON representation
A plugin for Elysia that add supports for get/set cookie
- Host: GitHub
- URL: https://github.com/elysiajs/elysia-cookie
- Owner: elysiajs
- License: mit
- Created: 2022-12-04T13:32:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T05:02:47.000Z (8 months ago)
- Last Synced: 2024-11-18T04:34:21.054Z (26 days ago)
- Language: TypeScript
- Size: 699 KB
- Stars: 10
- Watchers: 1
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-elysia - cookie - Plugin that add supports for get/set cookie. (Plugins)
README
This plugin has been merged into Elysia core and is deprecated, please use [Elysia.cookie](https://elysiajs.com/patterns/cookie.html) instead
# @elysiajs/cookie
Plugin for [Elysia](https://github.com/elysiajs/elysia) that add support for reading, and setting cookie.
## Installation
```bash
bun add @elysiajs/cookie
```
## Example
```typescript
import { Elysia } from 'elysia'
import { cookie } from '@elysiajs/cookie'
const app = new Elysia()
.use(cookie())
.get('/', ({ cookie: { user }, setCookie, removeCookie }) => {
if (user === 'admin') unsetCookie('user')
if (!user)
setCookie('user', 'saltyaom', {
httpOnly: true
})
return `Hi, ${user}!`
})
.listen(8080)
```
## API
### cookie
Parsed cookie from request in form of `Record`
```typescript
cookie: Record
```
### setCookie
Function to set new cookie
```typescript
setCookie: (
name: string,
value: string,
options?: CookieSerializeOptions
) => void
```
### removeCookie
A function to remove cookie
```typescript
removeCookie: (name: string) => void
```
### unsignCookie
Unsign cookie
```typescript
unsignCookie: (name: string) => void
```
### Serialize Options
Serialize option is based on [cookie package](https://npmjs.com/package/cookie)
```typescript
export interface CookieSerializeOptions {
/**
* Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.3|Domain Set-Cookie attribute}. By default, no
* domain is set, and most clients will consider the cookie to apply to only
* the current domain.
*/
domain?: string | undefined;
/**
* Specifies a function that will be used to encode a cookie's value. Since
* value of a cookie has a limited character set (and must be a simple
* string), this function can be used to encode a value into a string suited
* for a cookie's value.
*
* The default function is the global `encodeURIComponent`, which will
* encode a JavaScript string into UTF-8 byte sequences and then URL-encode
* any that fall outside of the cookie range.
*/
encode?(value: string): string;
/**
* Specifies the `Date` object to be the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.1|`Expires` `Set-Cookie` attribute}. By default,
* no expiration is set, and most clients will consider this a "non-persistent cookie" and will delete
* it on a condition like exiting a web browser application.
*
* *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3|cookie storage model specification}
* states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
* possible not all clients by obey this, so if both are set, they should
* point to the same date and time.
*/
expires?: Date | undefined;
/**
* Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.6|`HttpOnly` `Set-Cookie` attribute}.
* When truthy, the `HttpOnly` attribute is set, otherwise it is not. By
* default, the `HttpOnly` attribute is not set.
*
* *Note* be careful when setting this to true, as compliant clients will
* not allow client-side JavaScript to see the cookie in `document.cookie`.
*/
httpOnly?: boolean | undefined;
/**
* Specifies the number (in seconds) to be the value for the `Max-Age`
* `Set-Cookie` attribute. The given number will be converted to an integer
* by rounding down. By default, no maximum age is set.
*
* *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3|cookie storage model specification}
* states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
* possible not all clients by obey this, so if both are set, they should
* point to the same date and time.
*/
maxAge?: number | undefined;
/**
* Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.4|`Path` `Set-Cookie` attribute}.
* By default, the path is considered the "default path".
*/
path?: string | undefined;
/**
* Specifies the `string` to be the value for the [`Priority` `Set-Cookie` attribute][rfc-west-cookie-priority-00-4.1].
*
* - `'low'` will set the `Priority` attribute to `Low`.
* - `'medium'` will set the `Priority` attribute to `Medium`, the default priority when not set.
* - `'high'` will set the `Priority` attribute to `High`.
*
* More information about the different priority levels can be found in
* [the specification][rfc-west-cookie-priority-00-4.1].
*
* **note** This is an attribute that has not yet been fully standardized, and may change in the future.
* This also means many clients may ignore this attribute until they understand it.
*/
priority?: 'low' | 'medium' | 'high' | undefined;
/**
* Specifies the boolean or string to be the value for the {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|`SameSite` `Set-Cookie` attribute}.
*
* - `true` will set the `SameSite` attribute to `Strict` for strict same
* site enforcement.
* - `false` will not set the `SameSite` attribute.
* - `'lax'` will set the `SameSite` attribute to Lax for lax same site
* enforcement.
* - `'strict'` will set the `SameSite` attribute to Strict for strict same
* site enforcement.
* - `'none'` will set the SameSite attribute to None for an explicit
* cross-site cookie.
*
* More information about the different enforcement levels can be found in {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|the specification}.
*
* *note* This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.
*/
sameSite?: true | false | 'lax' | 'strict' | 'none' | undefined;
/**
* Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.5|`Secure` `Set-Cookie` attribute}. When truthy, the
* `Secure` attribute is set, otherwise it is not. By default, the `Secure` attribute is not set.
*
* *Note* be careful when setting this to `true`, as compliant clients will
* not send the cookie back to the server in the future if the browser does
* not have an HTTPS connection.
*/
secure?: boolean | undefined;
}
```
## Caveat
As the current state of Bun (0.1.4), there's no current way to set multiple cookie at once as Bun doesn't support setting multiple headers with same name which is required for setting multiple cookie in one response.