Nobody Picked Me

    @glorious/cookie

    0.3.0 • Public • Published

    Glorious Cookie

    CircleCI codecov Code Climate

    Install

    Glorious Cookie is available via npm:

    npm i @glorious/cookie --save
    

    Once installed, you just need import it in your module:

    import gcookie from '@glorious/cookie';

    or you may include it on your html:

    <script src="/node_modules/@glorious/cookie/dist/gcookie.min.js"></script>

    Usage

    Intending to be as simple as possible, Glorious Cookie has only three methods.

    Set

    /*
    ** @key: String [required]
    ** @value: String [required]
    ** @days: Number [optional] - If not provided, cookie is removed when the user closes the browser.
    ** @path: String [optional] - If not provided, cookie is valid for the entire site.
    */
    gcookie.set(key, value, days, path);

    Get

    /*
    ** @key: String [optional] - If not provided, all cookies will be returned.
    */
    gcookie.get(key);

    Remove

    /*
    ** @key: String [required]
    ** @path: String [optional] - If you have specified a path on gcookie.set(),
    **                            it will be required here.
    */
    gcookie.remove(key, path);

    Note: If cookies are not available, a warning will be logged when trying to set or remove a cookie.

    Keywords

    none

    Install

    npm i @glorious/cookie

    DownloadsWeekly Downloads

    5

    Version

    0.3.0

    License

    MIT

    Unpacked Size

    4.64 kB

    Total Files

    3

    Last publish

    Collaborators

    • rcamargo