@iamsquare/cookie-parse - v0.2.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Cookie-Parse

NPM GitHub issues GitHub License NPM

Basic cookie string/file parse utilities.

Getting started

Cookie-Parse utilities can be used in both browsers and Node.js:

Install Cookie-Parse by using npm:

npm i @iamsquare/cookie-parse

Since this library is compiled from Typescript, type definition files are provided by default. No additional @types installation required!

Documentation

You can check the documentation here

Building

Just clone this repo and build the library:

git clone --depth=0 https://github.com/iamsquare/cookie-parse
cd cookie-parse/
npm i
npm run prod

npm run prod will run Jest and build the library only if it passes all tests. To build without testing:

npm run build

TODO list
  • Documentation.
  • ParsedCookie serialization.
  • Check edge cases.
  • Add examples.
  • Migrate tests to typescript when I resolve some issues with typescript and custom jest matchers.

Built With

Licensing

The code in this project is licensed under MIT License.

Index

Interfaces

Functions

Functions

parseCookieString

  • Deserializes a semicolon separated key=value sequence like:

    'a=b; c=d; e=f;'

    to a ParsedCookie array

    Parameters

    • string: string

    Returns ParsedCookie[]

parseNetscapeFile

  • Reduces a file like:

    # Netscape HTTP Cookie File
# https://curl.haxx.se/rfc/cookie_spec.html
# This is a generated file! Do not edit.
.test.dev    TRUE    /    FALSE    1629107116    key1    value1
.test.dev    TRUE    /    FALSE    1629107116    key2    value2
.test.dev    TRUE    /    FALSE    1629107116    key3    value3

    to a ParsedCookie array

    Parameters

    • buffer: Buffer

    Returns ParsedCookie[]

parseNetscapeString

  • Reduces a string like:

    .test.dev    TRUE    /    FALSE    1629107116    key1    value1

    to a ParsedCookie

    Parameters

    • string: string

    Returns ParsedCookie

serializeToCookieString