-
Notifications
You must be signed in to change notification settings - Fork 8
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
Mark internal APIs with @internal
JSDoc tag
#104
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aryaemami59
added
documentation
Improvements or additions to documentation
chore
Does not impact code behavior
labels
Aug 15, 2024
mmkal
approved these changes
Aug 15, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. What do the jsdoc | characters do?
Same thing as before only slightly more TSDoc compliant. |
renovate bot
added a commit
to mmkal/trpc-cli
that referenced
this pull request
Aug 20, 2024
##### [`v0.20.0](https://github.com/mmkal/expect-type/releases/tag/v0.20.0) #### Breaking changes - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 This change updates how overloaded functions are treated. Now, `.parameters` gives you a *union* of the parameter-tuples that a function can take. For example, given the following type: ```ts type Factorize = { (input: number): number[] (input: bigint): bigint[] } ``` Behvaiour before: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[bigint]>() ``` Behaviour now: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[number] | [bigint]>() ``` There were similar changes for `.returns`, `.parameter(...)`, and `.toBeCallableWith`. Also, overloaded functions are now differentiated properly when using `.branded.toEqualTypeOf` (this was a bug that it seems nobody found). See [#83](mmkal/expect-type#83) for more details or look at the updated docs (including a new section called "[Overloaded functions](https://github.com/mmkal/expect-type#overloaded-functions)", which has more info on how this behaviour differs for TypeScript versions before 5.3). #### What's Changed - Fix rendering issue in readme by [@mrazauskas](https://github.com/mrazauskas) in mmkal/expect-type#69 - Fix minor issues in docs by [@aryaemami59](https://github.com/aryaemami59) in mmkal/expect-type#91 - create utils file by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#93 - branding.ts and messages.ts by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#95 - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 - Extends: explain myself [`1e37116`](mmkal/expect-type@1e37116) - Mark internal APIs with `@internal` JSDoc tag ([#104](mmkal/expect-type#104)) [`4c40b07`](mmkal/expect-type@4c40b07) - Re-export everything in `overloads.ts` file ([#107](mmkal/expect-type#107)) [`5ee0181`](mmkal/expect-type@5ee0181) - JSDoc improvements ([#100](mmkal/expect-type#100)) [`0bbeffa`](mmkal/expect-type@0bbeffa) **Full Changelog**: mmkal/expect-type@v0.19.0...v0.20.0
renovate bot
added a commit
to mmkal/trpc-cli
that referenced
this pull request
Aug 20, 2024
##### [`v0.20.0](https://github.com/mmkal/expect-type/releases/tag/v0.20.0) #### Breaking changes - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 This change updates how overloaded functions are treated. Now, `.parameters` gives you a *union* of the parameter-tuples that a function can take. For example, given the following type: ```ts type Factorize = { (input: number): number[] (input: bigint): bigint[] } ``` Behvaiour before: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[bigint]>() ``` Behaviour now: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[number] | [bigint]>() ``` There were similar changes for `.returns`, `.parameter(...)`, and `.toBeCallableWith`. Also, overloaded functions are now differentiated properly when using `.branded.toEqualTypeOf` (this was a bug that it seems nobody found). See [#83](mmkal/expect-type#83) for more details or look at the updated docs (including a new section called "[Overloaded functions](https://github.com/mmkal/expect-type#overloaded-functions)", which has more info on how this behaviour differs for TypeScript versions before 5.3). #### What's Changed - Fix rendering issue in readme by [@mrazauskas](https://github.com/mrazauskas) in mmkal/expect-type#69 - Fix minor issues in docs by [@aryaemami59](https://github.com/aryaemami59) in mmkal/expect-type#91 - create utils file by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#93 - branding.ts and messages.ts by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#95 - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 - Extends: explain myself [`1e37116`](mmkal/expect-type@1e37116) - Mark internal APIs with `@internal` JSDoc tag ([#104](mmkal/expect-type#104)) [`4c40b07`](mmkal/expect-type@4c40b07) - Re-export everything in `overloads.ts` file ([#107](mmkal/expect-type#107)) [`5ee0181`](mmkal/expect-type@5ee0181) - JSDoc improvements ([#100](mmkal/expect-type#100)) [`0bbeffa`](mmkal/expect-type@0bbeffa) **Full Changelog**: mmkal/expect-type@v0.19.0...v0.20.0
renovate bot
added a commit
to mmkal/trpc-cli
that referenced
this pull request
Aug 21, 2024
##### [`v0.20.0](https://github.com/mmkal/expect-type/releases/tag/v0.20.0) #### Breaking changes - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 This change updates how overloaded functions are treated. Now, `.parameters` gives you a *union* of the parameter-tuples that a function can take. For example, given the following type: ```ts type Factorize = { (input: number): number[] (input: bigint): bigint[] } ``` Behvaiour before: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[bigint]>() ``` Behaviour now: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[number] | [bigint]>() ``` There were similar changes for `.returns`, `.parameter(...)`, and `.toBeCallableWith`. Also, overloaded functions are now differentiated properly when using `.branded.toEqualTypeOf` (this was a bug that it seems nobody found). See [#83](mmkal/expect-type#83) for more details or look at the updated docs (including a new section called "[Overloaded functions](https://github.com/mmkal/expect-type#overloaded-functions)", which has more info on how this behaviour differs for TypeScript versions before 5.3). #### What's Changed - Fix rendering issue in readme by [@mrazauskas](https://github.com/mrazauskas) in mmkal/expect-type#69 - Fix minor issues in docs by [@aryaemami59](https://github.com/aryaemami59) in mmkal/expect-type#91 - create utils file by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#93 - branding.ts and messages.ts by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#95 - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 - Extends: explain myself [`1e37116`](mmkal/expect-type@1e37116) - Mark internal APIs with `@internal` JSDoc tag ([#104](mmkal/expect-type#104)) [`4c40b07`](mmkal/expect-type@4c40b07) - Re-export everything in `overloads.ts` file ([#107](mmkal/expect-type#107)) [`5ee0181`](mmkal/expect-type@5ee0181) - JSDoc improvements ([#100](mmkal/expect-type#100)) [`0bbeffa`](mmkal/expect-type@0bbeffa) **Full Changelog**: mmkal/expect-type@v0.19.0...v0.20.0
renovate bot
added a commit
to mmkal/trpc-cli
that referenced
this pull request
Aug 21, 2024
##### [`v0.20.0](https://github.com/mmkal/expect-type/releases/tag/v0.20.0) #### Breaking changes - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 This change updates how overloaded functions are treated. Now, `.parameters` gives you a *union* of the parameter-tuples that a function can take. For example, given the following type: ```ts type Factorize = { (input: number): number[] (input: bigint): bigint[] } ``` Behvaiour before: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[bigint]>() ``` Behaviour now: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[number] | [bigint]>() ``` There were similar changes for `.returns`, `.parameter(...)`, and `.toBeCallableWith`. Also, overloaded functions are now differentiated properly when using `.branded.toEqualTypeOf` (this was a bug that it seems nobody found). See [#83](mmkal/expect-type#83) for more details or look at the updated docs (including a new section called "[Overloaded functions](https://github.com/mmkal/expect-type#overloaded-functions)", which has more info on how this behaviour differs for TypeScript versions before 5.3). #### What's Changed - Fix rendering issue in readme by [@mrazauskas](https://github.com/mrazauskas) in mmkal/expect-type#69 - Fix minor issues in docs by [@aryaemami59](https://github.com/aryaemami59) in mmkal/expect-type#91 - create utils file by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#93 - branding.ts and messages.ts by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#95 - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 - Extends: explain myself [`1e37116`](mmkal/expect-type@1e37116) - Mark internal APIs with `@internal` JSDoc tag ([#104](mmkal/expect-type#104)) [`4c40b07`](mmkal/expect-type@4c40b07) - Re-export everything in `overloads.ts` file ([#107](mmkal/expect-type#107)) [`5ee0181`](mmkal/expect-type@5ee0181) - JSDoc improvements ([#100](mmkal/expect-type#100)) [`0bbeffa`](mmkal/expect-type@0bbeffa) **Full Changelog**: mmkal/expect-type@v0.19.0...v0.20.0
renovate bot
added a commit
to mmkal/trpc-cli
that referenced
this pull request
Aug 21, 2024
##### [`v0.20.0](https://github.com/mmkal/expect-type/releases/tag/v0.20.0) #### Breaking changes - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 This change updates how overloaded functions are treated. Now, `.parameters` gives you a *union* of the parameter-tuples that a function can take. For example, given the following type: ```ts type Factorize = { (input: number): number[] (input: bigint): bigint[] } ``` Behvaiour before: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[bigint]>() ``` Behaviour now: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[number] | [bigint]>() ``` There were similar changes for `.returns`, `.parameter(...)`, and `.toBeCallableWith`. Also, overloaded functions are now differentiated properly when using `.branded.toEqualTypeOf` (this was a bug that it seems nobody found). See [#83](mmkal/expect-type#83) for more details or look at the updated docs (including a new section called "[Overloaded functions](https://github.com/mmkal/expect-type#overloaded-functions)", which has more info on how this behaviour differs for TypeScript versions before 5.3). #### What's Changed - Fix rendering issue in readme by [@mrazauskas](https://github.com/mrazauskas) in mmkal/expect-type#69 - Fix minor issues in docs by [@aryaemami59](https://github.com/aryaemami59) in mmkal/expect-type#91 - create utils file by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#93 - branding.ts and messages.ts by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#95 - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 - Extends: explain myself [`1e37116`](mmkal/expect-type@1e37116) - Mark internal APIs with `@internal` JSDoc tag ([#104](mmkal/expect-type#104)) [`4c40b07`](mmkal/expect-type@4c40b07) - Re-export everything in `overloads.ts` file ([#107](mmkal/expect-type#107)) [`5ee0181`](mmkal/expect-type@5ee0181) - JSDoc improvements ([#100](mmkal/expect-type#100)) [`0bbeffa`](mmkal/expect-type@0bbeffa) **Full Changelog**: mmkal/expect-type@v0.19.0...v0.20.0
renovate bot
added a commit
to mmkal/trpc-cli
that referenced
this pull request
Aug 21, 2024
##### [`v0.20.0](https://github.com/mmkal/expect-type/releases/tag/v0.20.0) #### Breaking changes - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 This change updates how overloaded functions are treated. Now, `.parameters` gives you a *union* of the parameter-tuples that a function can take. For example, given the following type: ```ts type Factorize = { (input: number): number[] (input: bigint): bigint[] } ``` Behvaiour before: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[bigint]>() ``` Behaviour now: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[number] | [bigint]>() ``` There were similar changes for `.returns`, `.parameter(...)`, and `.toBeCallableWith`. Also, overloaded functions are now differentiated properly when using `.branded.toEqualTypeOf` (this was a bug that it seems nobody found). See [#83](mmkal/expect-type#83) for more details or look at the updated docs (including a new section called "[Overloaded functions](https://github.com/mmkal/expect-type#overloaded-functions)", which has more info on how this behaviour differs for TypeScript versions before 5.3). #### What's Changed - Fix rendering issue in readme by [@mrazauskas](https://github.com/mrazauskas) in mmkal/expect-type#69 - Fix minor issues in docs by [@aryaemami59](https://github.com/aryaemami59) in mmkal/expect-type#91 - create utils file by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#93 - branding.ts and messages.ts by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#95 - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 - Extends: explain myself [`1e37116`](mmkal/expect-type@1e37116) - Mark internal APIs with `@internal` JSDoc tag ([#104](mmkal/expect-type#104)) [`4c40b07`](mmkal/expect-type@4c40b07) - Re-export everything in `overloads.ts` file ([#107](mmkal/expect-type#107)) [`5ee0181`](mmkal/expect-type@5ee0181) - JSDoc improvements ([#100](mmkal/expect-type#100)) [`0bbeffa`](mmkal/expect-type@0bbeffa) **Full Changelog**: mmkal/expect-type@v0.19.0...v0.20.0
renovate bot
added a commit
to mmkal/trpc-cli
that referenced
this pull request
Aug 21, 2024
##### [`v0.20.0](https://github.com/mmkal/expect-type/releases/tag/v0.20.0) #### Breaking changes - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 This change updates how overloaded functions are treated. Now, `.parameters` gives you a *union* of the parameter-tuples that a function can take. For example, given the following type: ```ts type Factorize = { (input: number): number[] (input: bigint): bigint[] } ``` Behvaiour before: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[bigint]>() ``` Behaviour now: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[number] | [bigint]>() ``` There were similar changes for `.returns`, `.parameter(...)`, and `.toBeCallableWith`. Also, overloaded functions are now differentiated properly when using `.branded.toEqualTypeOf` (this was a bug that it seems nobody found). See [#83](mmkal/expect-type#83) for more details or look at the updated docs (including a new section called "[Overloaded functions](https://github.com/mmkal/expect-type#overloaded-functions)", which has more info on how this behaviour differs for TypeScript versions before 5.3). #### What's Changed - Fix rendering issue in readme by [@mrazauskas](https://github.com/mrazauskas) in mmkal/expect-type#69 - Fix minor issues in docs by [@aryaemami59](https://github.com/aryaemami59) in mmkal/expect-type#91 - create utils file by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#93 - branding.ts and messages.ts by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#95 - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 - Extends: explain myself [`1e37116`](mmkal/expect-type@1e37116) - Mark internal APIs with `@internal` JSDoc tag ([#104](mmkal/expect-type#104)) [`4c40b07`](mmkal/expect-type@4c40b07) - Re-export everything in `overloads.ts` file ([#107](mmkal/expect-type#107)) [`5ee0181`](mmkal/expect-type@5ee0181) - JSDoc improvements ([#100](mmkal/expect-type#100)) [`0bbeffa`](mmkal/expect-type@0bbeffa) **Full Changelog**: mmkal/expect-type@v0.19.0...v0.20.0
renovate bot
added a commit
to mmkal/trpc-cli
that referenced
this pull request
Aug 21, 2024
##### [`v0.20.0](https://github.com/mmkal/expect-type/releases/tag/v0.20.0) #### Breaking changes - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 This change updates how overloaded functions are treated. Now, `.parameters` gives you a *union* of the parameter-tuples that a function can take. For example, given the following type: ```ts type Factorize = { (input: number): number[] (input: bigint): bigint[] } ``` Behvaiour before: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[bigint]>() ``` Behaviour now: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[number] | [bigint]>() ``` There were similar changes for `.returns`, `.parameter(...)`, and `.toBeCallableWith`. Also, overloaded functions are now differentiated properly when using `.branded.toEqualTypeOf` (this was a bug that it seems nobody found). See [#83](mmkal/expect-type#83) for more details or look at the updated docs (including a new section called "[Overloaded functions](https://github.com/mmkal/expect-type#overloaded-functions)", which has more info on how this behaviour differs for TypeScript versions before 5.3). #### What's Changed - Fix rendering issue in readme by [@mrazauskas](https://github.com/mrazauskas) in mmkal/expect-type#69 - Fix minor issues in docs by [@aryaemami59](https://github.com/aryaemami59) in mmkal/expect-type#91 - create utils file by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#93 - branding.ts and messages.ts by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#95 - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 - Extends: explain myself [`1e37116`](mmkal/expect-type@1e37116) - Mark internal APIs with `@internal` JSDoc tag ([#104](mmkal/expect-type#104)) [`4c40b07`](mmkal/expect-type@4c40b07) - Re-export everything in `overloads.ts` file ([#107](mmkal/expect-type#107)) [`5ee0181`](mmkal/expect-type@5ee0181) - JSDoc improvements ([#100](mmkal/expect-type#100)) [`0bbeffa`](mmkal/expect-type@0bbeffa) **Full Changelog**: mmkal/expect-type@v0.19.0...v0.20.0
renovate bot
added a commit
to mmkal/trpc-cli
that referenced
this pull request
Aug 22, 2024
##### [`v0.20.0](https://github.com/mmkal/expect-type/releases/tag/v0.20.0) #### Breaking changes - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 This change updates how overloaded functions are treated. Now, `.parameters` gives you a *union* of the parameter-tuples that a function can take. For example, given the following type: ```ts type Factorize = { (input: number): number[] (input: bigint): bigint[] } ``` Behvaiour before: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[bigint]>() ``` Behaviour now: ```ts expectTypeOf<Factorize>().parameters.toEqualTypeOf<[number] | [bigint]>() ``` There were similar changes for `.returns`, `.parameter(...)`, and `.toBeCallableWith`. Also, overloaded functions are now differentiated properly when using `.branded.toEqualTypeOf` (this was a bug that it seems nobody found). See [#83](mmkal/expect-type#83) for more details or look at the updated docs (including a new section called "[Overloaded functions](https://github.com/mmkal/expect-type#overloaded-functions)", which has more info on how this behaviour differs for TypeScript versions before 5.3). #### What's Changed - Fix rendering issue in readme by [@mrazauskas](https://github.com/mrazauskas) in mmkal/expect-type#69 - Fix minor issues in docs by [@aryaemami59](https://github.com/aryaemami59) in mmkal/expect-type#91 - create utils file by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#93 - branding.ts and messages.ts by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#95 - improve overloads support, attempt 2 by [@mmkal](https://github.com/mmkal) in mmkal/expect-type#83 - Extends: explain myself [`1e37116`](mmkal/expect-type@1e37116) - Mark internal APIs with `@internal` JSDoc tag ([#104](mmkal/expect-type#104)) [`4c40b07`](mmkal/expect-type@4c40b07) - Re-export everything in `overloads.ts` file ([#107](mmkal/expect-type#107)) [`5ee0181`](mmkal/expect-type@5ee0181) - JSDoc improvements ([#100](mmkal/expect-type#100)) [`0bbeffa`](mmkal/expect-type@0bbeffa) **Full Changelog**: mmkal/expect-type@v0.19.0...v0.20.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR:
@internal
JSDoc tag.