resolveWeekStart()

Home > @gooddata/sdk-model > resolveWeekStart

resolveWeekStart() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Resolves the effective week start day from platform settings.

Signature:

export declare function resolveWeekStart(settings: ISettings | undefined): WeekStart;

Parameters

Parameter	Type	Description
settings	ISettings | undefined	platform settings to read; undefined yields the Sunday default

Returns:

WeekStart

the resolved WeekStart

Remarks

Applies the feature-flag override (enableNewUIWeekStartChange together with weekStartOnMondayEnabled force Monday), otherwise honors the weekStart setting, defaulting to Sunday when it (or the whole settings object) is missing. This is the single source of the derivation shared by the dashboard's week-start selector and non-dashboard hosts.