localForage / localForage/localForage

Should document the getter overloads of `.config()` method

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

Nobody has claimed this yet.

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

Description

Right now, there's no official, documented, way to read an instance's `name` or `storeName` properties. Having access to those can be useful for debugging.

They *are* technically accessible through the `localforage._config` property. However, that isn't documented, and the underscore conventionally means that users should avoid accessing it.

A basic example where this would be useful:
```js
const results = await store.getItems();
console.log("loaded items from", store._config.storeName);
```

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

Locate the documented `.config()` API and review its getter overloads. Document how to read an instance's `name` and `storeName` properties through the supported API, and include enough guidance that users do not need to access the underscored `_config` property.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.