Skip to main content

Log Out

Ends the current user session on the cloud backend and clears it from the browser.

Log Out ends the current session when its login input (displayed 'Do', signal) is triggered: the backend session is revoked, the stored session is removed from the browser, and the app-wide user service switches to logged-out — updating every User node (authenticated becomes false) and firing their Logged Out signal. done (signal) fires when this completes; failure (signal) fires with error (string value) set if the request fails.

When to use it

The action behind a log-out button or menu item. To react to the session ending (e.g. navigate to the login page), listen on this node's done or the User node's Logged Out signal.

At a glance

CategoryCloud Services
Type namenet.noodl.user.LogOut
Available inbrowser
SSR compatibilitysafe
Provided bynoodl-viewer-react

Inputs

Signals

NameTypeDefaultDescription
loginSignalSigns the current user out and clears the stored session

Outputs

Signals

NameTypeDefaultDescription
completedSignalFires after every invocation, whatever the outcome — wire this to carry on regardless. Failure still fires and still carries its reason, so this cannot hide an error
doneSignalFires once the session has been ended

Failure outputs

NameTypeDefaultDescription
errorStringWhy the last sign-out failed; empty until one does
failureSignalFires when the sign-out was refused, after the reason has been reported on the error channel

Patterns

  • Button onClicklogin (Do), done → navigate to the public/login page.

Examples

Log in, show the user, log out

The authentication triangle: Log In takes username/password values and a login signal, firing success or failure (+error). The User node is the session's single source of truth — its authenticated boolean and profile outputs update on login/logout, so UI binds to it rather than to the action nodes. Log Out ends the session from anywhere. Gate visible areas on authenticated, not on the login node's success pulse.

Log In, User

Generated

This page is generated from node-catalog-enriched.json. Do not edit it by hand — run npm run docs:nodes to regenerate, and fix the source enrichment instead.