Class WeekInformation

A Week calculator, useful to be passed in to week_of_year() on Date and DateTime types

See the Rust documentation for WeekInformation for more information.

Index

Constructors

Accessors

ffiValue firstWeekday weekend

Methods

isWeekend createWithProvider

Constructors

constructor

new WeekInformation(locale: Locale): WeekInformation
Parameters
- locale: Locale
Returns WeekInformation
- Defined in WeekInformation.d.ts:47

Accessors

ffiValue

get ffiValue(): number
Returns number
- Defined in WeekInformation.d.ts:18

firstWeekday

get firstWeekday(): Weekday
Returns the weekday that starts the week for this object's locale

See the Rust documentation for first_weekday for more information.

Returns Weekday
- Defined in WeekInformation.d.ts:33

weekend

get weekend(): WeekdaySetIterator
See the Rust documentation for weekend for more information.

Returns WeekdaySetIterator
- Defined in WeekInformation.d.ts:45

Methods

isWeekend

isWeekend(day: Weekday): boolean
See the Rust documentation for weekend for more information.

See the Rust documentation for contains for more information.
Parameters
- day: Weekday
Returns boolean
- Defined in WeekInformation.d.ts:40

`Static`createWithProvider

createWithProvider(provider: DataProvider, locale: Locale): WeekInformation
Creates a new [WeekInformation] from locale data using a particular data source.

See the Rust documentation for try_new for more information.
Parameters
- provider: DataProvider
- locale: Locale
Returns WeekInformation
- Defined in WeekInformation.d.ts:26