Skip to main content Link Search Menu Expand Document (external link)
effect

Cookies.ts overview

Since v1.0.0

Exports Grouped by Category

combinators

get

Get a cookie from a Cookies object

Signature

declare const get: {
  (name: string): (self: Cookies) => Option.Option<Cookie>
  (self: Cookies, name: string): Option.Option<Cookie>
}

Source

Since v1.0.0

getValue

Get a cookie from a Cookies object

Signature

declare const getValue: {
  (name: string): (self: Cookies) => Option.Option<string>
  (self: Cookies, name: string): Option.Option<string>
}

Source

Since v1.0.0

merge

Combine two Cookies objects, removing duplicates from the first

Signature

declare const merge: { (that: Cookies): (self: Cookies) => Cookies; (self: Cookies, that: Cookies): Cookies }

Source

Since v1.0.0

remove

Remove a cookie by name

Signature

declare const remove: { (name: string): (self: Cookies) => Cookies; (self: Cookies, name: string): Cookies }

Source

Since v1.0.0

set

Add a cookie to a Cookies object

Signature

declare const set: {
  (name: string, value: string, options?: Cookie["options"]): (self: Cookies) => Either.Either<Cookies, CookiesError>
  (self: Cookies, name: string, value: string, options?: Cookie["options"]): Either.Either<Cookies, CookiesError>
}

Source

Since v1.0.0

setAll

Add multiple cookies to a Cookies object

Signature

declare const setAll: {
  (
    cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>
  ): (self: Cookies) => Either.Either<Cookies, CookiesError>
  (
    self: Cookies,
    cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>
  ): Either.Either<Cookies, CookiesError>
}

Source

Since v1.0.0

setAllCookie

Add multiple cookies to a Cookies object

Signature

declare const setAllCookie: {
  (cookies: Iterable<Cookie>): (self: Cookies) => Cookies
  (self: Cookies, cookies: Iterable<Cookie>): Cookies
}

Source

Since v1.0.0

setCookie

Add a cookie to a Cookies object

Signature

declare const setCookie: { (cookie: Cookie): (self: Cookies) => Cookies; (self: Cookies, cookie: Cookie): Cookies }

Source

Since v1.0.0

unsafeSet

Add a cookie to a Cookies object

Signature

declare const unsafeSet: {
  (name: string, value: string, options?: Cookie["options"]): (self: Cookies) => Cookies
  (self: Cookies, name: string, value: string, options?: Cookie["options"]): Cookies
}

Source

Since v1.0.0

unsafeSetAll

Add multiple cookies to a Cookies object, throwing an error if invalid

Signature

declare const unsafeSetAll: {
  (cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>): (self: Cookies) => Cookies
  (self: Cookies, cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>): Cookies
}

Source

Since v1.0.0

constructors

empty

An empty Cookies object

Signature

declare const empty: Cookies

Source

Since v1.0.0

fromIterable

Create a Cookies object from an Iterable

Signature

declare const fromIterable: (cookies: Iterable<Cookie>) => Cookies

Source

Since v1.0.0

fromReadonlyRecord

Create a Cookies object from an Iterable

Signature

declare const fromReadonlyRecord: (cookies: Record.ReadonlyRecord<string, Cookie>) => Cookies

Source

Since v1.0.0

fromSetCookie

Create a Cookies object from a set of Set-Cookie headers

Signature

declare const fromSetCookie: (headers: Iterable<string> | string) => Cookies

Source

Since v1.0.0

makeCookie

Create a new cookie

Signature

declare const makeCookie: (
  name: string,
  value: string,
  options?: Cookie["options"] | undefined
) => Either.Either<Cookie, CookiesError>

Source

Since v1.0.0

unsafeMakeCookie

Create a new cookie, throwing an error if invalid

Signature

declare const unsafeMakeCookie: (name: string, value: string, options?: Cookie["options"] | undefined) => Cookie

Source

Since v1.0.0

cookie

Signature

export interface Cookie extends Inspectable.Inspectable {
  readonly [CookieTypeId]: CookieTypeId
  readonly name: string
  readonly value: string
  readonly valueEncoded: string
  readonly options?:
    | {
        readonly domain?: string | undefined
        readonly expires?: Date | undefined
        readonly maxAge?: Duration.DurationInput | undefined
        readonly path?: string | undefined
        readonly priority?: "low" | "medium" | "high" | undefined
        readonly httpOnly?: boolean | undefined
        readonly secure?: boolean | undefined
        readonly partitioned?: boolean | undefined
        readonly sameSite?: "lax" | "strict" | "none" | undefined
      }
    | undefined
}

Source

Since v1.0.0

decoding

parseHeader

Parse a cookie header into a record of key-value pairs

Adapted from https://github.com/fastify/fastify-cookie under MIT License

Signature

declare const parseHeader: (header: string) => Record<string, string>

Source

Since v1.0.0

encoding

serializeCookie

Serialize a cookie into a string

Adapted from https://github.com/fastify/fastify-cookie under MIT License

Signature

declare const serializeCookie: (self: Cookie) => string

Source

Since v1.0.0

toCookieHeader

Serialize a Cookies object into a Cookie header

Signature

declare const toCookieHeader: (self: Cookies) => string

Source

Since v1.0.0

toRecord

To record

Signature

declare const toRecord: (self: Cookies) => Record<string, string>

Source

Since v1.0.0

toSetCookieHeaders

Serialize a Cookies object into Headers object containing one or more Set-Cookie headers

Signature

declare const toSetCookieHeaders: (self: Cookies) => Array<string>

Source

Since v1.0.0

errors

CookiesError (class)

Signature

declare class CookiesError

Source

Since v1.0.0

models

Cookies (interface)

Signature

export interface Cookies extends Pipeable, Inspectable.Inspectable {
  readonly [TypeId]: TypeId
  readonly cookies: Record.ReadonlyRecord<string, Cookie>
}

Source

Since v1.0.0

refinements

isCookies

Signature

declare const isCookies: (u: unknown) => u is Cookies

Source

Since v1.0.0

isEmpty

Signature

declare const isEmpty: (self: Cookies) => boolean

Source

Since v1.0.0

type ids

CookieTypeId

Signature

declare const CookieTypeId: unique symbol

Source

Since v1.0.0

CookieTypeId (type alias)

Signature

type CookieTypeId = typeof CookieTypeId

Source

Since v1.0.0

ErrorTypeId

Signature

declare const ErrorTypeId: unique symbol

Source

Since v1.0.0

ErrorTypeId (type alias)

Signature

type ErrorTypeId = typeof ErrorTypeId

Source

Since v1.0.0

TypeId

Signature

declare const TypeId: unique symbol

Source

Since v1.0.0

TypeId (type alias)

Signature

type TypeId = typeof TypeId

Source

Since v1.0.0