Skip to content

chore(types): Update JSDocs for SessionTask #6396

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

Merged
merged 2 commits into from
Jul 29, 2025
Merged

chore(types): Update JSDocs for SessionTask #6396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b60944f
Update JSDocs for `SessionTask`
LauraBeatris Jul 24, 2025
c604711
Add changeset
LauraBeatris Jul 25, 2025
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
5 changes: 5 additions & 0 deletions .changeset/cyan-hoops-bow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Update JSDocs for `SessionTask` to align with Clerk documentation
5 changes: 2 additions & 3 deletions packages/types/src/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,12 +327,11 @@ export interface PublicUserData {
}

/**
* Represents a required action that a user must complete
* before their session becomes fully active
* Represents the current pending task of a session.
*/
export interface SessionTask {
/**
* The unique identifier for the type of task that needs to be completed
* A unique identifier for the task
*/
key: 'select-organization';
}
Expand Down
Loading