Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[2f] Add TypeScript declarations, JSDoc, and fix nftMarkerCount/markerNFTCount naming

Open
  • Is something wrong?
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
javascript, typescript
Domain
api, developer-experience

Research direction

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.

Written by the indexing model from the issue text.

Description

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.js and related source files

Problem Description

Three related API-quality gaps:

  1. No type declarations: No .d.ts file exists, so TypeScript consumers get no type checking or IDE autocompletion.
  2. No JSDoc: Public methods have no documentation, making the API opaque to new consumers.
  3. Naming inconsistency: nftMarkerCount (field name) and markerNFTCount (local variable name) diverge — one of them is wrong, and the inconsistency is a footgun for callers.

Expected Behavior

  • A .d.ts declaration 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 / markerNFTCount are 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 convert src/ to TypeScript outright
  • Add JSDoc on every public method
  • Decide on naming: nftMarkerCount vs markerNFTCount and rename consistently throughout src/ 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.

Dominant language
JavaScript
Stars
8
Forks
2
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from webarkit/FeatureSET-Display

All issues in webarkit/FeatureSET-Display

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.