All files / src helper.slugs.js

100% Statements 6/6
100% Branches 4/4
100% Functions 2/2
100% Lines 6/6

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62                                                              20x               1240x   8x   1240x                   304x   283x            
/*
 * Part of Pleiar.no - a collection of tools for nurses
 *
 * Copyright (C) Fagforbundet 2019
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
// @flow
 
import GithubSlugger from 'github-slugger';
 
/**
 * This is a global helper object that can be used to generate slugs. Uses
 * `github-slugger` to generate the slugs.
 *
 * Caveat: You must make sure that no code that you are calling is also
 * generating slugs at the same time, since you then may end up with
 * inconsistent slugs (see the docs for `reset()`.
 */
const slug = {
    __ghs: null,
 
    /**
     * Retrieve a single slug
     */
    get(name: string): string
    {
        if (slug.__ghs === null)
        {
            slug.__ghs = new GithubSlugger();
        }
        return slug.__ghs.slug(name,false);
    },
 
    /**
     * Resets the slug object. `github-slugger` has some logic that avoids ever
     * generating two identical slugs. So you should always do a .reset() before you
     * start generating slugs, so that you get consistent ones.
     */
    reset ()
    {
        if(slug.__ghs !== null)
        {
            slug.__ghs.reset();
        }
    }
};
 
export default slug;