sveltekit-oidc - v1.1.1
Preparing search index...
OIDCInstance
Type Alias OIDCInstance
type
OIDCInstance
=
{
backChannelLogoutHandler
:
()
=>
RequestHandler
;
callbackHandler
:
(
handlerOptions
?:
OIDCCallbackHandlerOptions
,
)
=>
RequestHandler
;
clearSession
:
(
cookies
:
Cookies
)
=>
Promise
<
void
>
;
createActions
:
(
actionOptions
?:
OIDCActionOptions
,
)
=>
Readonly
<
{
login
:
Action
;
logout
:
Action
}
>
;
getMetadata
:
()
=>
Promise
<
OIDCDiscoveryDocument
>
;
getPublicSession
:
(
event
:
RequestEvent
,
)
=>
Promise
<
OIDCPublicSession
|
null
>
;
getSession
:
(
event
:
RequestEvent
)
=>
Promise
<
OIDCSession
|
null
>
;
getSessionManagementConfig
:
()
=>
Promise
<
OIDCSessionManagementConfig
>
;
handle
:
Handle
;
handleBackChannelLogout
:
(
event
:
RequestEvent
)
=>
Promise
<
Response
>
;
handleCallback
:
(
event
:
RequestEvent
)
=>
Promise
<
OIDCCallbackResult
>
;
login
:
(
event
:
RequestEvent
,
loginOptions
?:
OIDCLoginOptions
,
)
=>
Promise
<
never
>
;
loginHandler
:
(
defaults
?:
OIDCLoginOptions
)
=>
RequestHandler
;
logout
:
(
event
:
RequestEvent
,
logoutOptions
?:
OIDCLogoutOptions
,
)
=>
Promise
<
never
>
;
logoutHandler
:
(
defaults
?:
OIDCLogoutOptions
)
=>
RequestHandler
;
requireAuth
:
(
event
:
RequestEvent
,
returnTo
?:
string
,
)
=>
Promise
<
OIDCSession
>
;
}
Index
Properties
back
Channel
Logout
Handler
callback
Handler
clear
Session
create
Actions
get
Metadata
get
Public
Session
get
Session
get
Session
Management
Config
handle
handle
Back
Channel
Logout
handle
Callback
login
login
Handler
logout
logout
Handler
require
Auth
Properties
back
Channel
Logout
Handler
backChannelLogoutHandler
:
()
=>
RequestHandler
callback
Handler
callbackHandler
:
(
handlerOptions
?:
OIDCCallbackHandlerOptions
)
=>
RequestHandler
clear
Session
clearSession
:
(
cookies
:
Cookies
)
=>
Promise
<
void
>
create
Actions
createActions
:
(
actionOptions
?:
OIDCActionOptions
,
)
=>
Readonly
<
{
login
:
Action
;
logout
:
Action
}
>
get
Metadata
getMetadata
:
()
=>
Promise
<
OIDCDiscoveryDocument
>
get
Public
Session
getPublicSession
:
(
event
:
RequestEvent
)
=>
Promise
<
OIDCPublicSession
|
null
>
get
Session
getSession
:
(
event
:
RequestEvent
)
=>
Promise
<
OIDCSession
|
null
>
get
Session
Management
Config
getSessionManagementConfig
:
()
=>
Promise
<
OIDCSessionManagementConfig
>
handle
handle
:
Handle
handle
Back
Channel
Logout
handleBackChannelLogout
:
(
event
:
RequestEvent
)
=>
Promise
<
Response
>
handle
Callback
handleCallback
:
(
event
:
RequestEvent
)
=>
Promise
<
OIDCCallbackResult
>
login
login
:
(
event
:
RequestEvent
,
loginOptions
?:
OIDCLoginOptions
)
=>
Promise
<
never
>
login
Handler
loginHandler
:
(
defaults
?:
OIDCLoginOptions
)
=>
RequestHandler
logout
logout
:
(
event
:
RequestEvent
,
logoutOptions
?:
OIDCLogoutOptions
,
)
=>
Promise
<
never
>
logout
Handler
logoutHandler
:
(
defaults
?:
OIDCLogoutOptions
)
=>
RequestHandler
require
Auth
requireAuth
:
(
event
:
RequestEvent
,
returnTo
?:
string
)
=>
Promise
<
OIDCSession
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
back
Channel
Logout
Handler
callback
Handler
clear
Session
create
Actions
get
Metadata
get
Public
Session
get
Session
get
Session
Management
Config
handle
handle
Back
Channel
Logout
handle
Callback
login
login
Handler
logout
logout
Handler
require
Auth
sveltekit-oidc - v1.1.1
Loading...