core / io.islandtime.format / DateTimeTextProvider / dayOfWeekTextFor

dayOfWeekTextFor

(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) open fun dayOfWeekTextFor(value: Long, style: TextStyle, locale: <ERROR CLASS>): String?

Get the localized day of the week text for a given ISO day of week number.

Parameters

value - an ISO day of week number, from Monday (1) to Sunday (7)

style - the style of the text

locale - the locale

Exceptions

DateTimeException - if the value is not a valid day of the week number

Return
the localized day of week text or null if unavailable

(jvm) open fun dayOfWeekTextFor(value: Long, style: TextStyle, locale: Locale): String?