-
Notifications
You must be signed in to change notification settings - Fork 454
feat(tanstack-react-start): Add experimental export #6957
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@clerk/tanstack-react-start': patch | ||
| --- | ||
|
|
||
| Add `@clerk/tanstack-react-start/experimental` export with new `useSignIn` and `useSignUp` hooks. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export { useSignInSignal as useSignIn, useSignUpSignal as useSignUp } from '@clerk/clerk-react/experimental'; | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion | 🟠 Major Add JSDoc documentation for public API. These exported hooks constitute a public API surface and should be documented with JSDoc comments explaining their purpose, usage, and relationship to the underlying experimental signals. As per coding guidelines Apply this diff to add JSDoc: +/**
+ * Experimental hook that provides access to the sign-in flow state and methods.
+ * This is an alias for `useSignInSignal` from `@clerk/clerk-react/experimental`.
+ * @experimental This API is experimental and may change in future versions.
+ */
export { useSignInSignal as useSignIn, useSignUpSignal as useSignUp } from '@clerk/clerk-react/experimental';Alternatively, document both hooks separately: +/**
+ * Experimental hook that provides access to the sign-in flow state and methods.
+ * This is an alias for `useSignInSignal` from `@clerk/clerk-react/experimental`.
+ * @experimental This API is experimental and may change in future versions.
+ */
+export { useSignInSignal as useSignIn } from '@clerk/clerk-react/experimental';
+
+/**
+ * Experimental hook that provides access to the sign-up flow state and methods.
+ * This is an alias for `useSignUpSignal` from `@clerk/clerk-react/experimental`.
+ * @experimental This API is experimental and may change in future versions.
+ */
+export { useSignUpSignal as useSignUp } from '@clerk/clerk-react/experimental';
🤖 Prompt for AI Agents |
||
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.
Use "minor" version bump for new feature.
According to semantic versioning, a "patch" bump is for backward-compatible bug fixes, while a "minor" bump is for backward-compatible new functionality. Since this PR adds new exports and hooks, it should be a minor version bump.
Apply this diff:
📝 Committable suggestion
🤖 Prompt for AI Agents