client.auth.signOut

Sign out the current session.

Signature

class Client {
  auth: {
    signOut(): Promise<void>
  }
}

Examples

await bf.auth.signOut()

Throws

Error	Condition
`ApiError`	API request failed
`NetworkError`	Network issue

Pitfalls

Session invalidated — the current API session/token is invalidated server-side
Client state — clear any local session state after calling this

See also

{auto-injected}

Tested against

{auto-injected}