Application Load

IAppLoad

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IAppLoad

Initial storefront data, customer profile and available API endpoints.

app/interfaces/orionplace/appBase/IAppLoad.ts
TypeScript
export interface IAppLoad {
	// Shared storefront settings and initial data.
	init: IAppLoadCommon;
	// Public API methods, grouped under paths.
	unauth: IAppLoadPathsRecord;
	// Current customer profile. Omitted for guests.
	user?: IApploadUserProfile;
	// Authenticated-session methods. Omitted for guests; the backend checks
	// permissions.
	auth?: IAppLoadPathsRecord;
	// Whether seller-panel features are enabled for this storefront.
	seller_panel_enabled?: boolean;
	// Product-preview key for a signed-in account with seller information.
	// Do not publish its value; buyer-facing interfaces do not need this key.
	view_key?: string;
	// Backend Application Load preparation time in seconds; only with project
	// debug enabled.
	// Excludes response serialization and network transfer.
	spent_total?: number;
	// Backend init loading time in seconds. Only with project debug enabled.
	spent_init?: number;
	// Public API discovery loading time in seconds. Only with project debug
	// enabled.
	unauth_spent?: number;
	// Profile and auth preparation time in seconds. Debug only; zero for guests.
	auth_spent?: number;
}