sindresorhus/electron-store

Use expiration

Open

#125 opened on Jun 16, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (4,304 stars) (150 forks)batch import
enhancementhelp wanted

Description

It would be awesome if we can set a max age for a single key or the whole store.

For example:

store.set('foo.bar', true, { maxAge: expirationDate });

Contributor guide

Tech stack
javascriptnodejs
Domain
desktopapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptFamiliarity with Electron Store API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
To implement this feature, modify the `set` method in the main store file (likely `index.js` or `source/index.js`) to accept an optional `maxAge` option. When a key is set with a `maxAge`, store the expiration timestamp alongside the value. On `get`, check if the stored timestamp has passed and return `undefined` or delete the key if expired. Look at existing tests in the repository for patterns. Consider adding a `clearExpired` method to clean up expired entries. This issue has been open since 2020 with 3 comments; no active work is ongoing.