Skip to content

docs: correct the URL example in snakeizeKeysDeep's JSDoc #2019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
zunixport wants to merge 1 commit into from
Closed

docs: correct the URL example in snakeizeKeysDeep's JSDoc #2019

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/utils/case.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,10 @@ function snakeToCamel(key: string): string {
* format the API expects.
*
* **Acronym caveat:** every uppercase character emits its own underscore, so
* acronym-style keys are split between letters: `URL` → `url`,
* `userID` → `user_i_d`, `NFTContract` → `n_f_t_contract`. This is deliberate
* acronym-style keys are split between letters: `URL` → `u_r_l`,
* `userID` → `user_i_d`, `NFTContract` → `n_f_t_contract`. Only the position-0
* guard keeps a leading capital from becoming a leading underscore, so `URL`
* loses none of its inner splits. This is deliberate
* (the roundtrip with `camelizeKeysDeep` is consistent under generic rules)
* but consumers calling `snakeizeKeysDeep` directly should avoid PascalCase
* acronyms in key names — use `userId` / `nftContract` instead.
Expand Down