localForage/localForage

Deprecate key() function

Open

#281 opened on Oct 19, 2014

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (24,184 stars) (1,260 forks)batch import
help wantedquestion

Description

(Discussion started in #280 and all the way back in #3.)

The key() function is certainly weird and I don't think 1:1 mapping of localStorage's API is the exact selling feature of localForage (even if it once was). In future versions deprecating this functionality might be smart to reduce the size of the library and the effort to write and test drivers.

I'm not sure what the actual gains to removing it would be, as it might not take up much actual code, but if no one seems to be using it we should drop support for it in future versions.

Thoughts?

Contributor guide

Tech stack
javascript
Domain
frontendapi
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.
mostly clear
Prerequisites
Understanding of localForage APIFamiliarity with deprecation patterns
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Review the discussion in #280 and #3 to understand the history of the key() function. Assess the current implementation in the source code (likely in 'src/localforage.js' or similar) and the driver files. Determine the impact on existing tests and consider adding a deprecation warning. Update documentation accordingly. Since the issue has no assignees and no recent activity, propose a concrete plan for deprecation in a future major version.