Microsoft/TypeScript

`IDBObjectStore` `keyPath` missing `null` type.

Open

#61,209 opened on Feb 18, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: lib.d.tsHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

🔎 Search Terms

  • IDBObjectStore
  • IDBKeyPath
  • keyPath

🕗 Version & Regression Information

  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about IDBObjectStore keyPath.

🙁 Actual behavior

IDBObjectStore instance member keyPath does not include null in its union of types.

🙂 Expected behavior

All versions of the IndexedDB specification has stated that keyPath will be the key path value provided at time of store creation, or null if not specified or when using a key generation such as autoIncrement. The type should be string | string[] | null.

Additional information about the issue

Contributor guide

Research direction
Update the type definition for `IDBObjectStore.keyPath` to include `null` by modifying the corresponding `.d.ts` file in the TypeScript repository. Confirm the specification references provided.
Tech stack
typescript
Domain
frontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85