Skip to content

[VBLOCKS-4564] Typescript 5.x: fix docstrings and exports #328

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.

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

Conversation

mhuynh5757
Copy link
Collaborator

Contributing to Twilio

All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

  • I acknowledge that all my contributions will be made under the project's license.

Pull Request Details

JIRA link(s):

Description

This PR adjusts the docstrings to comply with the new Typedoc specifications. Also, export previously non-exported members whose types are necessary for users.

Burndown

Before review

  • Updated CHANGELOG.md if necessary
  • Added unit tests if necessary
  • Updated affected documentation
  • Verified locally with npm test
  • Manually sanity tested running locally
  • Ready for review

Before merge

  • Got one or more +1s
  • Squashed erroneous commits if necessary
  • Re-tested if necessary

@mhuynh5757 mhuynh5757 requested a review from kpchoy May 7, 2025 16:11
@@ -85,28 +102,51 @@ export function getPreciseSignalingErrorByCode(
return getErrorByCode(errorCode);
}

// Application errors that can be avoided by good app logic
/**
* The error that is thrown when an invalid argument is passed to a library API.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice replacement 👍

@mhuynh5757 mhuynh5757 merged commit 43746e0 into feature/upgrade-typescript-4.x-to-5.x May 7, 2025
9 checks passed
@mhuynh5757 mhuynh5757 deleted the task/typescript-5.x-docstrings branch May 7, 2025 20:17
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.

2 participants