[2f] Add TypeScript declarations, JSDoc, and fix nftMarkerCount/markerNFTCount naming
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Refactoring
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- javascript, typescript
- Ambito
- api, developer-experience
Direzione di ricerca
Start by inventorying the public methods in src/ARFset.js and related source files, then inspect examples for uses of nftMarkerCount and markerNFTCount. Done means the public API has TypeScript declarations, JSDoc with parameter and return information, and one consistent marker-count name throughout src/ and examples.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
Add TypeScript declarations, JSDoc on all public methods, and resolve nftMarkerCount / markerNFTCount naming inconsistency
Environment
- Product/Service: FeatureSET-Display — JavaScript API
- Files:
src/ARFset.jsand related source files
Problem Description
Three related API-quality gaps:
- No type declarations: No
.d.tsfile exists, so TypeScript consumers get no type checking or IDE autocompletion. - No JSDoc: Public methods have no documentation, making the API opaque to new consumers.
- Naming inconsistency:
nftMarkerCount(field name) andmarkerNFTCount(local variable name) diverge — one of them is wrong, and the inconsistency is a footgun for callers.
Expected Behavior
- A
.d.tsdeclaration file (or TypeScript source) covers all public API surface. - Every public method has a JSDoc comment with parameter types, return type, and a one-line description.
nftMarkerCount/markerNFTCountare reconciled to a single consistent name throughout the codebase.
Actual Behavior
No type declarations, no JSDoc, inconsistent public naming.
Tasks
- Add TypeScript declarations (
.d.ts) — or convertsrc/to TypeScript outright - Add JSDoc on every public method
- Decide on naming:
nftMarkerCountvsmarkerNFTCountand rename consistently throughoutsrc/and any examples
Impact
Low — Developer experience and API usability. No runtime behavior change.
Additional Context
Converting src/ to TypeScript directly is the higher-value option (catches bugs at compile time, generates .d.ts automatically) but is a larger scope. Adding a hand-authored .d.ts is a quick win that unblocks TypeScript consumers immediately. The naming fix should happen regardless of which approach is chosen.
- Lingua principale
- JavaScript
- Stelle
- 8
- Fork
- 2
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di webarkit/FeatureSET-Display
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 42/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 58/100
Tutte le issue di webarkit/FeatureSET-Display
Issue simili
-
Update HugeIcons library Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
antfu-collective/icones#398 ·
-
ECmail.com Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
wesbos/burner-email-providers#554 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
radiantearth/stac-browser#1023 ·
-
HMR stops working Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
components-web-app/docs#92 ·