sveltekit-oidc - v2.0.1
Preparing search index...
OIDCInstance
Type Alias OIDCInstance<TIdentity, TRequestData>
type
OIDCInstance
<
TIdentity
extends
OIDCUserClaims
=
OIDCUserClaims
,
TRequestData
=
undefined
,
>
=
{
backChannelLogoutHandler
:
<
T
extends
MinimalRequestEvent
=
RequestEvent
>
()
=>
MinimalRequestHandler
<
T
,
>
;
callbackHandler
:
<
T
extends
MinimalRequestEvent
=
RequestEvent
>
(
handlerOptions
?:
OIDCCallbackHandlerOptions
<
TIdentity
>
,
)
=>
MinimalRequestHandler
<
T
>
;
clearSession
:
(
cookies
:
Cookies
)
=>
Promise
<
void
>
;
createActions
:
(
actionOptions
?:
OIDCActionOptions
,
)
=>
Readonly
<
{
login
:
Action
;
logout
:
Action
}
>
;
createRequestContext
:
(
event
:
MinimalRequestEvent
,
)
=>
Promise
<
OIDCHandleLocals
<
TIdentity
,
TRequestData
>
>
;
getMetadata
:
()
=>
Promise
<
OIDCDiscoveryDocument
>
;
getPublicSession
:
(
event
:
MinimalRequestEvent
&
{
depends
?:
(
dependency
:
string
)
=>
void
}
,
)
=>
Promise
<
OIDCPublicSession
<
TIdentity
>
|
null
>
;
getSession
:
(
event
:
{
cookies
:
Cookies
}
,
)
=>
Promise
<
OIDCSession
<
TIdentity
>
|
null
>
;
getSessionManagementConfig
:
()
=>
Promise
<
OIDCSessionManagementConfig
>
;
handle
:
Handle
;
handleBackChannelLogout
:
(
event
:
MinimalRequestEvent
)
=>
Promise
<
Response
>
;
handleCallback
:
(
event
:
MinimalRequestEvent
,
)
=>
Promise
<
OIDCCallbackResult
<
TIdentity
>
>
;
login
:
(
event
:
MinimalRequestEvent
,
loginOptions
?:
OIDCLoginOptions
,
)
=>
Promise
<
never
>
;
loginHandler
:
<
T
extends
MinimalRequestEvent
=
RequestEvent
>
(
defaults
?:
OIDCLoginOptions
,
)
=>
MinimalRequestHandler
<
T
>
;
logout
:
(
event
:
MinimalRequestEvent
,
logoutOptions
?:
OIDCLogoutOptions
,
)
=>
Promise
<
never
>
;
logoutHandler
:
<
T
extends
MinimalRequestEvent
=
RequestEvent
>
(
defaults
?:
OIDCLogoutOptions
,
)
=>
MinimalRequestHandler
<
T
>
;
requireAuth
:
(
event
:
{
cookies
:
Cookies
;
url
:
URL
}
,
returnTo
?:
string
,
)
=>
Promise
<
OIDCSession
<
TIdentity
>
>
;
toPublicSession
:
(
context
:
OIDCHandleLocals
<
TIdentity
,
TRequestData
>
|
null
|
undefined
,
depends
?:
(
dependency
:
string
)
=>
void
,
)
=>
OIDCPublicSession
<
TIdentity
>
|
null
;
}
Type Parameters
TIdentity
extends
OIDCUserClaims
=
OIDCUserClaims
TRequestData
=
undefined
Index
Properties
back
Channel
Logout
Handler
callback
Handler
clear
Session
create
Actions
create
Request
Context
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
to
Public
Session
Properties
back
Channel
Logout
Handler
backChannelLogoutHandler
:
<
T
extends
MinimalRequestEvent
=
RequestEvent
>
()
=>
MinimalRequestHandler
<
T
,
>
callback
Handler
callbackHandler
:
<
T
extends
MinimalRequestEvent
=
RequestEvent
>
(
handlerOptions
?:
OIDCCallbackHandlerOptions
<
TIdentity
>
,
)
=>
MinimalRequestHandler
<
T
>
clear
Session
clearSession
:
(
cookies
:
Cookies
)
=>
Promise
<
void
>
create
Actions
createActions
:
(
actionOptions
?:
OIDCActionOptions
,
)
=>
Readonly
<
{
login
:
Action
;
logout
:
Action
}
>
create
Request
Context
createRequestContext
:
(
event
:
MinimalRequestEvent
,
)
=>
Promise
<
OIDCHandleLocals
<
TIdentity
,
TRequestData
>
>
get
Metadata
getMetadata
:
()
=>
Promise
<
OIDCDiscoveryDocument
>
get
Public
Session
getPublicSession
:
(
event
:
MinimalRequestEvent
&
{
depends
?:
(
dependency
:
string
)
=>
void
}
,
)
=>
Promise
<
OIDCPublicSession
<
TIdentity
>
|
null
>
get
Session
getSession
:
(
event
:
{
cookies
:
Cookies
}
,
)
=>
Promise
<
OIDCSession
<
TIdentity
>
|
null
>
get
Session
Management
Config
getSessionManagementConfig
:
()
=>
Promise
<
OIDCSessionManagementConfig
>
handle
handle
:
Handle
handle
Back
Channel
Logout
handleBackChannelLogout
:
(
event
:
MinimalRequestEvent
)
=>
Promise
<
Response
>
handle
Callback
handleCallback
:
(
event
:
MinimalRequestEvent
,
)
=>
Promise
<
OIDCCallbackResult
<
TIdentity
>
>
login
login
:
(
event
:
MinimalRequestEvent
,
loginOptions
?:
OIDCLoginOptions
,
)
=>
Promise
<
never
>
login
Handler
loginHandler
:
<
T
extends
MinimalRequestEvent
=
RequestEvent
>
(
defaults
?:
OIDCLoginOptions
,
)
=>
MinimalRequestHandler
<
T
>
logout
logout
:
(
event
:
MinimalRequestEvent
,
logoutOptions
?:
OIDCLogoutOptions
,
)
=>
Promise
<
never
>
logout
Handler
logoutHandler
:
<
T
extends
MinimalRequestEvent
=
RequestEvent
>
(
defaults
?:
OIDCLogoutOptions
,
)
=>
MinimalRequestHandler
<
T
>
require
Auth
requireAuth
:
(
event
:
{
cookies
:
Cookies
;
url
:
URL
}
,
returnTo
?:
string
,
)
=>
Promise
<
OIDCSession
<
TIdentity
>
>
to
Public
Session
toPublicSession
:
(
context
:
OIDCHandleLocals
<
TIdentity
,
TRequestData
>
|
null
|
undefined
,
depends
?:
(
dependency
:
string
)
=>
void
,
)
=>
OIDCPublicSession
<
TIdentity
>
|
null
Projects an already-loaded request context without repeating any server work.
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
back
Channel
Logout
Handler
callback
Handler
clear
Session
create
Actions
create
Request
Context
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
to
Public
Session
sveltekit-oidc - v2.0.1
Loading...
Projects an already-loaded request context without repeating any server work.