PHP's setcookie in TypeScript

How to use

Install via yarn add locutus and import: import { setcookie } from 'locutus/php/network/setcookie'.

Or with CommonJS: const { setcookie } = require('locutus/php/network/setcookie')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	setcookie('author_name', 'Kevin van Zonneveld')	true

Dependencies

This function uses the following Locutus functions:

• setrawcookie (php/network)

Here's what our current TypeScript equivalent to PHP's setcookie looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { setrawcookie } from '../network/setrawcookie.ts'

export function setcookie(
  name: string,
  value: string,
  expires?: string | number | Date | null,
  path?: string | null,
  domain?: string | null,
  secure?: boolean,
): boolean {
  //      discuss at: https://locutus.io/php/setcookie/
  // parity verified: PHP 8.3
  //     original by: Jonas Raoni Soares Silva (https://www.jsfromhell.com)
  //     bugfixed by: Andreas
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: setcookie('author_name', 'Kevin van Zonneveld')
  //       returns 1: true

  return setrawcookie(name, encodeURIComponent(value), expires, path, domain, secure)
}

import { setrawcookie } from '../network/setrawcookie.ts'

export function setcookie(name, value, expires, path, domain, secure) {
  //      discuss at: https://locutus.io/php/setcookie/
  // parity verified: PHP 8.3
  //     original by: Jonas Raoni Soares Silva (https://www.jsfromhell.com)
  //     bugfixed by: Andreas
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: setcookie('author_name', 'Kevin van Zonneveld')
  //       returns 1: true

  return setrawcookie(name, encodeURIComponent(value), expires, path, domain, secure)
}

// php/network/setrawcookie (Locutus dependency module)
type CookieExpires = string | number | Date | null | undefined

function setrawcookie(
  name: string,
  value: string,
  expires?: CookieExpires,
  path?: string | null,
  domain?: string | null,
  secure?: boolean,
): boolean {
  //  discuss at: https://locutus.io/php/setrawcookie/
  // original by: Brett Zamir (https://brett-zamir.me)
  // original by: setcookie
  // improved by: Kevin van Zonneveld (https://kvz.io)
  //    input by: Michael
  //      note 1: This function requires access to the `window` global and is Browser-only
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  //   example 1: setrawcookie('author_name', 'Kevin van Zonneveld')
  //   returns 1: true

  if (typeof window === 'undefined') {
    return true
  }

  let normalizedExpires = expires

  if (typeof normalizedExpires === 'string' && /^\d+$/.test(normalizedExpires)) {
    normalizedExpires = parseInt(normalizedExpires, 10)
  }

  if (normalizedExpires instanceof Date) {
    normalizedExpires = normalizedExpires.toUTCString()
  } else if (typeof normalizedExpires === 'number') {
    normalizedExpires = new Date(normalizedExpires * 1e3).toUTCString()
  }

  const parts = [name + '=' + value]
  if (normalizedExpires) {
    parts.push('expires=' + normalizedExpires)
  }
  if (path) {
    parts.push('path=' + path)
  }
  if (domain) {
    parts.push('domain=' + domain)
  }

  if (secure) {
    parts.push('secure')
  }

  window.document.cookie = parts.join(';')

  return true
}

// php/network/setcookie (target function module)
function setcookie(
  name: string,
  value: string,
  expires?: string | number | Date | null,
  path?: string | null,
  domain?: string | null,
  secure?: boolean,
): boolean {
  //      discuss at: https://locutus.io/php/setcookie/
  // parity verified: PHP 8.3
  //     original by: Jonas Raoni Soares Silva (https://www.jsfromhell.com)
  //     bugfixed by: Andreas
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: setcookie('author_name', 'Kevin van Zonneveld')
  //       returns 1: true

  return setrawcookie(name, encodeURIComponent(value), expires, path, domain, secure)
}

// php/network/setrawcookie (Locutus dependency module)
function setrawcookie(name, value, expires, path, domain, secure) {
  //  discuss at: https://locutus.io/php/setrawcookie/
  // original by: Brett Zamir (https://brett-zamir.me)
  // original by: setcookie
  // improved by: Kevin van Zonneveld (https://kvz.io)
  //    input by: Michael
  //      note 1: This function requires access to the `window` global and is Browser-only
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  //   example 1: setrawcookie('author_name', 'Kevin van Zonneveld')
  //   returns 1: true

  if (typeof window === 'undefined') {
    return true
  }

  let normalizedExpires = expires

  if (typeof normalizedExpires === 'string' && /^\d+$/.test(normalizedExpires)) {
    normalizedExpires = parseInt(normalizedExpires, 10)
  }

  if (normalizedExpires instanceof Date) {
    normalizedExpires = normalizedExpires.toUTCString()
  } else if (typeof normalizedExpires === 'number') {
    normalizedExpires = new Date(normalizedExpires * 1e3).toUTCString()
  }

  const parts = [name + '=' + value]
  if (normalizedExpires) {
    parts.push('expires=' + normalizedExpires)
  }
  if (path) {
    parts.push('path=' + path)
  }
  if (domain) {
    parts.push('domain=' + domain)
  }

  if (secure) {
    parts.push('secure')
  }

  window.document.cookie = parts.join(';')

  return true
}

// php/network/setcookie (target function module)
function setcookie(name, value, expires, path, domain, secure) {
  //      discuss at: https://locutus.io/php/setcookie/
  // parity verified: PHP 8.3
  //     original by: Jonas Raoni Soares Silva (https://www.jsfromhell.com)
  //     bugfixed by: Andreas
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: setcookie('author_name', 'Kevin van Zonneveld')
  //       returns 1: true

  return setrawcookie(name, encodeURIComponent(value), expires, path, domain, secure)
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

« More PHP network functions

Star