Cookie Plugin
This plugin adds support for using cookie in Elysia handler.
Install with:
bun add @elysiajs/cookie
bun add @elysiajs/cookie
Then use it:
import { Elysia } from 'elysia'
import { cookie } from '@elysiajs/cookie'
new Elysia()
.use(cookie())
.get('/profile', ({ cookie: { name } }) => name)
.put('/sign/:name', ({ setCookie, params: { name } }) => {
setCookie('name', name)
return name
})
.listen(8080)
import { Elysia } from 'elysia'
import { cookie } from '@elysiajs/cookie'
new Elysia()
.use(cookie())
.get('/profile', ({ cookie: { name } }) => name)
.put('/sign/:name', ({ setCookie, params: { name } }) => {
setCookie('name', name)
return name
})
.listen(8080)
Config
This plugin extends config from cookie
Below is a config which accepted by the plugin
secret
The secret key for signing/un-signing cookies.
If an array is passed, will use Key Rotation.
Key rotation is when an encryption key is retired and replaced by generating a new cryptographic key.
Below is a config extends from cookie
domain
Specifies the value for the Domain Set-Cookie attribute.
By default, no domain is set, and most clients will consider the cookie to apply to only the current domain.
encode
@default encodeURIComponent
Specifies a function that will be used to encode a cookie's value.
Since the 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.
expires
Specifies the Date object to be the value for the 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.
TIP
The cookie storage model specification states that if both expires
and maxAge
are set, then maxAge
takes precedence, but not all clients may obey this, so if both are set, they should point to the same date and time.
httpOnly
@default false
Specifies the boolean value for the HttpOnly Set-Cookie attribute.
When truthy, the HttpOnly attribute is set, otherwise, it is not.
By default, the HttpOnly attribute is not set.
TIP
be careful when setting this to true, as compliant clients will not allow client-side JavaScript to see the cookie in document.cookie
.
maxAge
@default 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.
TIP
The cookie storage model specification states that if both expires
and maxAge
are set, then maxAge
takes precedence, but not all clients may obey this, so if both are set, they should point to the same date and time.
path
Specifies the value for the Path Set-Cookie attribute.
By default, the path handler is considered the default path.
priority
Specifies the string to be the value for the Priority Set-Cookie attribute. 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.
TIP
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
Specifies the boolean or string to be the value for the 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. 'none' will set the SameSite attribute to None for an explicit cross-site cookie. 'strict' will set the SameSite attribute to Strict for strict same-site enforcement. More information about the different enforcement levels can be found in the specification.
TIP
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.
secure
Specifies the boolean value for the Secure Set-Cookie attribute. When truthy, the Secure attribute is set, otherwise, it is not. By default, the Secure attribute is not set.
TIP
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.
Handler
Below are the value added to the handler.
cookie
An object representation of request cookies.
Type:
cookie: Record<string, string>
cookie: Record<string, string>
setCookie
A function to set a cookie and return it to the client.
Type:
setCookie(name: string, value: string, options?: SetCookieOptions) => void
setCookie(name: string, value: string, options?: SetCookieOptions) => void
SetCookieOptions
extends cookie, which is the same as config.
removeCookie
A function to unset cookies.
Type:
removeCookie(name: string) => void
removeCookie(name: string) => void
unsignCookie
A function to validate and signed cookies and retrieved their value.
unsignCookie(input: string, secret: string):
| {
valid: true
value: string
}
| {
valid: false
value: undefined
}
unsignCookie(input: string, secret: string):
| {
valid: true
value: string
}
| {
valid: false
value: undefined
}
Pattern
Below you can find the common patterns to use the plugin.
Set default config:
By default, the config is passed to setCookie
and inherits its value.
import { Elysia } from 'elysia'
import { cookie } from '@elysiajs/cookie'
new Elysia()
.use(cookie({
httpOnly: true
}))
.post('/sign/:name', ({ setCookie, params: { name } }) => {
setCookie('name', name, {
maxAge: 86400
})
})
.listen(8080)
import { Elysia } from 'elysia'
import { cookie } from '@elysiajs/cookie'
new Elysia()
.use(cookie({
httpOnly: true
}))
.post('/sign/:name', ({ setCookie, params: { name } }) => {
setCookie('name', name, {
maxAge: 86400
})
})
.listen(8080)
This will sign a cookie with maxAge
of 86400
and httpOnly
to true
.
Sign & unsign cookie
new Elysia()
.get('/sign/:name', ({ params: { name }, setCookie }) => {
setCookie('name', name, {
signed: true
})
return name
})
.get('/auth', ({ unsignCookie, cookie: { name }, set }) => {
const { valid, value } = unsignCookie(name)
if (!valid) {
set.status = 401
return 'Unauthorized'
}
return value
})
new Elysia()
.get('/sign/:name', ({ params: { name }, setCookie }) => {
setCookie('name', name, {
signed: true
})
return name
})
.get('/auth', ({ unsignCookie, cookie: { name }, set }) => {
const { valid, value } = unsignCookie(name)
if (!valid) {
set.status = 401
return 'Unauthorized'
}
return value
})