tibi-docs/docs/md/server-javascript-kontext/packages/cookie.md
2023-06-03 18:07:58 +00:00

1.3 KiB

Das Cookie-Paket stellt Funktionen bereit, um HTTP-Cookies aus den Anfragen zu lesen und in den Antworten zu setzen. Mit der Methode get(name: string): string kann der Wert eines bestimmten Cookies ausgelesen werden. Der Name des Cookies wird als Parameter übergeben. Die Methode set(name: string, value: string, options?: {maxAge?: number, path?: string, domain?: string, secure?: boolean, httpOnly?: boolean}): void ermöglicht das Setzen eines Cookies. Der Name und Wert des Cookies, sowie optionale Parameter wie maximales Alter (maxAge), Pfad (path), Domain, Secure- und HttpOnly-Flag können übergeben werden. Cookies sind ein essentieller Bestandteil für das Session-Management und personalisierte Nutzererfahrungen im Web.

interface CookiePackage {
    /**
     * get cookie from http header
     *
     * @param name cookie name
     */
    get(name: string): string

    /**
     * set cookie via http header
     *
     * @param name cookie name
     * @param value cookie value
     * @param options cookie options
     */
    set(
        name: string,
        value: string,
        options?: {
            maxAge?: number
            path?: string
            domain?: string
            secure?: boolean
            httpOnly?: boolean
        }
    ): void
}