AuthClientIdleOptions

Defined in: react/src/auth/types.ts:76

Idle-session configuration forwarded to the underlying AuthClient.

Properties

onIdle?

optional onIdle?: () => unknown

Defined in: react/src/auth/types.ts:78

Called once the user has been idle for idleTimeout ms.

Returns

unknown

---

idleTimeout?

optional idleTimeout?: number

Defined in: react/src/auth/types.ts:80

Idle timeout in ms.

Default

600_000 (10 minutes)

---

captureScroll?

optional captureScroll?: boolean

Defined in: react/src/auth/types.ts:82

Treat scroll events as activity.

Default

false

---

scrollDebounce?

optional scrollDebounce?: number

Defined in: react/src/auth/types.ts:84

Scroll debounce in ms.

Default

100

---

disableIdle?

optional disableIdle?: boolean

Defined in: react/src/auth/types.ts:86

Disable idle detection entirely.

Default

false

---

disableDefaultIdleCallback?

optional disableDefaultIdleCallback?: boolean

Defined in: react/src/auth/types.ts:91

Disable the built-in idle callback, which signs the user out and reloads the page.

Default

false