README

# @goa/cookies

[![npm version](https://badge.fury.io/js/%40goa%2Fcookies.svg)](https://npmjs.org/package/@goa/cookies)

`@goa/cookies` is a fork of <kbd>🗝 [Signed And Unsigned Cookies Based On Keygrip](https://github.com/pillarjs/cookies)</kbd> Written In ES6, Annotated With [Externs](/types/externs) And Optimised With [JavaScript Compiler](https://compiler.page).

```sh
yarn add @goa/cookies
```

<strong>[📕 READ DOCUMENTATION ON GITHUB](https://github.com/idiocc/cookies)</strong>

## Wiki

Wiki contains the following pages with additional information about the package.

<kbd>🍪 [Cookie Attributes](../../wiki/Cookie-Attributes)</kbd>
===

<a href="https://github.com/idiocc/cookies/wiki/Cookie-Attributes"><img src="/wiki/cookies.gif" alt="Cookies Attributes: domain, expires, httpOnly, maxAge, overwrite, path, sameSite, secure"></a>

<kbd>🚄 [Express And Connect Middleware Constructor](../../wiki/Express-And-Connect)</kbd>
===

Cookies can be used via express and connect easily by calling the middleware constructor functions to get middleware that can be installed on the app.

<kbd>⚜️ [Keygrip](../../wiki/Keygrip)</kbd>
===

The <em>Keygrip</em> can be passed in the <em><code>keys</code></em> property of the constructor. By default, the new instance of <em>Keygrip</em> will be created when an array of keys is passed, but custom implementations of <em>Keygrip</em> which override the sign and verify functions can be passed to cookies.

<kbd>🔗 [View Compiler Externs](../../wiki/Compiler-Externs)</kbd>
===

The externs are required to compile the package yet keep the options' properties in tact, i.e. without renaming the properties. The API is preserved for 2nd level compilation in other packages, such as Goa, and is tested on the 1st level compilation of the package itself.

<table>
  <tr>
    <th>
      <a href="https://artd.eco">
        <img width="100" src="https://raw.githubusercontent.com/wrote/wrote/master/images/artdeco.png"
          alt="Art Deco">
      </a>
    </th>
    <th>© <a href="https://artd.eco">Art Deco</a> for <a href="https://idio.cc">Idio</a> 2019</th>
    <th>
      <a href="https://idio.cc">
        <img src="https://avatars3.githubusercontent.com/u/40834161?s=100" width="100" alt="Idio">
      </a>
    </th>
    <th>
      <a href="https://www.technation.sucks" title="Tech Nation Visa">
        <img width="100" src="https://raw.githubusercontent.com/idiocc/cookies/master/wiki/arch4.jpg"
          alt="Tech Nation Visa">
      </a>
    </th>
    <th><a href="https://www.technation.sucks">Tech Nation Visa Sucks</a></th>
  </tr>
</table>