npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gdpr-guard-local

v1.2.0

Published

A simple local storage adapter for gdpr-guard

Downloads

47

Readme

gdpr-guard-local

A simple local storage adapter for gdpr-guard

This library predefines logic to store/save and restore gdpr-guard state from localStorage.

If you need any help, you're more than welcome on my official Discord server dedicated to my open-source projects.

You can read the online documentation.

How to import

This library re-exports what's exported by gdpr-guard.

import {
    // everything from gdpr-guard
    defaults,
    LocalStorageSavior,
} from "gdpr-guard-local"


// In your browser
const {
	// everything from gdpr-guard
	defaults,
	LocalStorageSavior,
} = gdprGuardLocal;

LocalStorageSavior

LocalStorageSavior is a class that specializes the Savior API for local storage.

It is mainly for libraries developers or can be used as parameters for a library.

To construct one, simply pass a LocalStorageConfig object followed by a LocalStoreFactory (both are optional with default values):

interface LocalStorageConfig{
    storeKey: string; // key of the serialized manager in local storage
    versionKey: string; // key of the version of the serialized manager in local storage
    version: string|number; // current version
    comparator: (oldVersion, newVersion) => boolean; // if the versions are different
    expiration: () => Date; // expiration date from current time
}

type LocalStoreFactory = () => LocalStore;

interface LocalStore{
    has(key: string): Promise<boolean>;
    set(key: string, value: any, expiration: Date): Promise<void>;
    remove(key: string): Promise<void>;
    get(key: string): Promise<any>;
    removeExpiredKeys(): Promise<void>;
}

const savior = new LocalStorageSavior(myConfig, myStoreFactory);

To help users and developers, we provide default values as well as ways to easily create new values for the parameters.

Defaults

const {
    defaultStoreFactory, // the default argument of the savior constructor
    expiration, // utility function
    defaultConfig, // the default argument of the savior
    makeConfig,
} = defaults;

The makeConfig function is a utility function that merges the user provided config object with the default config:

declare const makeConfig: (config: Partial<LocalStorageConfig> = {}): LocalStorageConfig;

For instance, you can customize the savior like this:

const savior = new LocalStorageSavior(
    makeConfig({
        version: "v1.0.0",
        //storeKey will be gdpr
        //versionKey will be gdpr__version
    }),
    defaultStoreFactory, // optional, that's already the default parameter
);