Skip to content

docs: restore model API reference - #505

Merged
JimmyDaddy merged 1 commit into
masterfrom
fix/api-reference
Aug 18, 2026
Merged

JimmyDaddy merged 1 commit into
masterfrom
fix/api-reference

Conversation

@yicai-dev

Copy link
Copy Markdown
Collaborator

Fixes #394.

Summary

  • document the public Bone base class and its shared AbstractBone implementation
  • expose model persistence, association, schema, and query APIs in the generated reference
  • fix JSDoc parameter descriptions that produced 12 parser errors
  • build TypeScript automatically before generating JSDoc
  • regenerate the checked-in API reference, including create, bulkCreate, upsert, sync, and the full data-type set

Verification

  • npm run jsdoc completes without parser errors from a clean generated lib build
  • TypeScript build and TS 4.9 declaration generation pass
  • ESLint passes for the changed TypeScript sources
  • generated Bone and AbstractBone pages contain the expected persistence APIs

@yicai-dev
yicai-dev requested a review from JimmyDaddy August 17, 2026 10:00
@codecov

codecov Bot commented Aug 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.58%. Comparing base (fcc053a) to head (9b3b2ef).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #505   +/-   ##
=======================================
  Coverage   97.58%   97.58%           
=======================================
  Files          47       47           
  Lines        4272     4272           
  Branches     1033     1033           
=======================================
  Hits         4169     4169           
  Misses         14       14           
  Partials       89       89           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JimmyDaddy
JimmyDaddy merged commit 9c753cf into master Aug 18, 2026
6 checks passed
@JimmyDaddy
JimmyDaddy deleted the fix/api-reference branch August 18, 2026 03:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

希望可以增加对API文档的使用说明

3 participants