Authentication StateAPI
API
The API for interacting with authentication state.
Anchor to orderstatusapiOrderStatusApi
The API object provided to this and other customer-account.order-status
extension targets.
- Anchor to authenticationStateauthenticationStateReadonlySignalLike<AuthenticationState>required
The authentication state of Order status page.
Docs_OrderStatus_AuthenticationStateApi
- authenticationState
The authentication state of Order status page.
ReadonlySignalLike<AuthenticationState>
export interface Docs_OrderStatus_AuthenticationStateApi
extends Pick<OrderStatusApi<any>, 'authenticationState'> {}
ReadonlySignalLike
Represents a read-only value managed on the main thread that an extension can subscribe to. Example: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker. This interface is compatible with Preact's ReadonlySignal: https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709
- subscribe
(fn: (value: T) => void) => () => void
- value
T
export interface ReadonlySignalLike<T> {
readonly value: T;
subscribe(fn: (value: T) => void): () => void;
}
AuthenticationState
'fully_authenticated' | 'pre_authenticated'
Was this section helpful?