Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#25 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
javascript, typescript
Lĩnh vực
api, developer-experience

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
JavaScript
Star
8
Fork
2
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của webarkit/FeatureSET-Display

Tất cả issue của webarkit/FeatureSET-Display

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.