Edit

Share via

SignOutResult class

Package:
@azure/msal-browser
Extends

AuthFlowResultBase<SignOutResultState, SignOutError, void>

Constructors

SignOutResult()

Creates a new instance of SignOutResult.

Inherited Properties

data
error
state

Methods

createWithError(unknown)

Creates a new instance of SignOutResult with an error.
isCompleted()

Checks if the sign-out operation is completed.
isFailed()

Checks if the sign-out operation failed.

Constructor Details

SignOutResult()

Creates a new instance of SignOutResult.

new SignOutResult()

Inherited Property Details

data 

data?: void

Property Value

void

Inherited From AuthFlowResultBase.data

error 

error?: SignOutError

Property Value

SignOutError

Inherited From AuthFlowResultBase.error

state 

state: SignOutResultState

Property Value

SignOutResultState

Inherited From AuthFlowResultBase.state

Method Details

createWithError(unknown)

Creates a new instance of SignOutResult with an error.

static function createWithError(error: unknown): SignOutResult

Parameters

error

unknown

The error that occurred during the sign-out operation.

Returns

SignOutResult

isCompleted()

Checks if the sign-out operation is completed.

function isCompleted(): this

Returns

this

isFailed()

Checks if the sign-out operation failed.

function isFailed(): this

Returns

this