Skip to content

Commit e404456

Browse files
authored
chore(types): Update JSDocs for SessionTask (#6396)
1 parent 0bdd0df commit e404456

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

.changeset/cyan-hoops-bow.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@clerk/types': patch
3+
---
4+
5+
Update JSDocs for `SessionTask` to align with Clerk documentation

packages/types/src/session.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -327,12 +327,11 @@ export interface PublicUserData {
327327
}
328328

329329
/**
330-
* Represents a required action that a user must complete
331-
* before their session becomes fully active
330+
* Represents the current pending task of a session.
332331
*/
333332
export interface SessionTask {
334333
/**
335-
* The unique identifier for the type of task that needs to be completed
334+
* A unique identifier for the task
336335
*/
337336
key: 'select-organization';
338337
}

0 commit comments

Comments
 (0)