Biblioteca `Cookies` da Azion

Aprenda como usar a biblioteca Cookies da Azion para lidar com cookies em aplicações web.

Ver como Markdown

A biblioteca Cookies da Azion fornece funções utilitárias para obter e definir cookies em uma requisição e uma resposta HTTP. Esta biblioteca é útil para lidar com cookies em aplicações da web, garantindo facilidade de uso e consistência.

Saiba mais sobre as Azion Libraries

Uso

getCookie

Recupera o valor de um cookie específico da requisição HTTP.

Parâmetros:

ParâmetroTipoDescrição
reqRequestO objeto de requisição HTTP.
keystring (opcional)O nome do cookie a ser recuperado. Se não for fornecido, retorna todos os cookies como um objeto.
prefixOptionsCookiePrefix (opcional)O prefixo para o cookie ('host' ou 'secure').

Retorno:

TipoDescrição
string | undefined | Record<string, string>O valor do cookie, ou um objeto com todos os cookies se nenhuma chave for fornecida.

Exemplo:

import { setCookie } from 'azion/cookies';
import type { CookieOptions } from 'azion/cookies';
const options: CookieOptions = { maxAge: 3600 };
const res = setCookie(response, 'my-cookie', 'cookie-value', options);

setCookie

Configura um cookie na resposta HTTP.

Parâmetros:

ParâmetroTipoDescrição
resResponseO objeto de resposta HTTP.
namestringO nome do cookie.
valuestringO valor do cookie.
optionsCookieOptions (opcional)Opções adicionais para definir o cookie.

O tipo CookieOption usado para o parâmetro options é um objeto com as seguintes propriedades:

OpçãoTipoDescrição
maxAgenumberOpcional. A idade máxima do cookie, em segundos.
expiresDateOpcional. A data de expiração do cookie.
pathstringOpcional. O caminho no servidor para o qual o cookie será enviado.
domainstringOpcional. O domínio para o qual o cookie é válido.
securebooleanOpcional. Se verdadeiro, o cookie será transmitido apenas sobre HTTPS seguro.
httpOnlybooleanOpcional. Se verdadeiro, o cookie é inacessível à API Document.cookie do JavaScript.
sameSite'Strict' | 'Lax' | 'None'Opcional. Controla como o cookie é enviado com requisições entre sites.

Exemplo:

import { setCookie } from 'azion/cookies';
import type { CookieOptions } from 'azion/cookies';
const options: CookieOptions = { maxAge: 3600 };
const res = setCookie(response, 'my-cookie', 'cookie-value', options);