Skip to content
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

Jump to bottom

Rename casing functions and deprecate old ones #44

Closed
gustavoguichard opened this issue Oct 6, 2023 · 3 comments · Fixed by #76
Closed

Rename casing functions and deprecate old ones #44

gustavoguichard opened this issue Oct 6, 2023 · 3 comments · Fixed by #76
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@gustavoguichard
Copy link
Owner

gustavoguichard commented Oct 6, 2023 •
edited
Loading

See the discussion for v2 roadmap.

  • We should use JSDoc comments to deprecate both type and runtime methods
  • Update README to omit deprecated functions and show new ones
@gustavoguichard gustavoguichard added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 6, 2023
@gustavoguichard
Copy link
Owner Author

@p9f .
I'll update the v1 roadmap to include lowerCase and upperCase functions (similar to lodash ones)

@gustavoguichard
Copy link
Owner Author

gustavoguichard commented Oct 9, 2023 •
edited
Loading

@jly36963 implemented the new lowerCase and upperCase methods.
According to our discussion we decided not to export the types for those functions as it would be confused with the ones provided by TS Lowercase and Uppercase.
We are putting a note on the README instead that you can achieve that with Lowercase<DelimiterCase<T, " ">>.

Now I think it is a good time to start renaming and deprecating the other functions.

The first person that decides to do it: post something here so our work doesn't clash. 🙏🏽

@p9f p9f mentioned this issue Oct 10, 2023
Merged
@gustavoguichard gustavoguichard mentioned this issue Oct 10, 2023
Merged
@gustavoguichard
Copy link
Owner Author

More context here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Rename casing functions and deprecate old ones gustavoguichard/string-ts
1 participant
@gustavoguichard