Feature/add more inline documentation

[Howard86]

• What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

doc update

• What is the current behavior? (You can also link to an open issue here)

showing limited info & example when working with next-api-handler on IDE

• What is the new behavior (if this is a feature change)?

add jsdoc to related methods and class

• Other information:

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments

| Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **next-api-handler** | ⬜️ Ignored ([Inspect](https://vercel.com/howard86/next-api-handler/9LhvFWmXmSKy73JsCbwKFarv76vK)) | [Visit Preview](https://next-api-handler-git-feature-add-more-inline-do-5267fd-howard86.vercel.app) | | May 3, 2023 8:09pm | | **next-api-handler-example** | ⬜️ Ignored ([Inspect](https://vercel.com/howard86/next-api-handler-example/DA8Tcmf3beDeDnUujtXmCt8Mf1d5)) | [Visit Preview](https://next-api-handler-example-git-feature-add-more-i-771f97-howard86.vercel.app) | | May 3, 2023 8:09pm |

[codeclimate[bot]]

Code Climate has analyzed commit 66ae2266 and detected 0 issues on this pull request.

View more on Code Climate.

[cypress[bot]]

Passing run #183 ↗︎

0

10

0

0

0

Details:

null
Project: next-api-handler	Commit: 66ae22665a
Status: Passed	Duration: 00:09 💡
Started: May 3, 2023 8:11 PM	Ended: May 3, 2023 8:11 PM

_{This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.}

[codecov[bot]]

Codecov Report

Merging #99 (66ae226) into main (350b2d1) will increase coverage by 0.05%. The diff coverage is n/a.

@@            Coverage Diff             @@
##             main      #99      +/-   ##
==========================================
+ Coverage   99.84%   99.90%   +0.05%     
==========================================
  Files           8        8              
  Lines         660     1070     +410     
  Branches       88       89       +1     
==========================================
+ Hits          659     1069     +410     
  Misses          1        1              

see 6 files with indirect coverage changes

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more