localForage / localForage/localForage

Deprecate key() function

Open
#281 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted question
Dominant language
JavaScript
Stars
25.8k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the discussion in issues #280 and #3, then assess whether the public key() API is still used and what deprecation would require. Done is not defined in this issue; a maintainer decision and a concrete migration or implementation scope would be needed first.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.