📝 Commit Details:
This commit is contained in:
60
backend/node_modules/date-fns/differenceInBusinessDays.d.ts
generated
vendored
Normal file
60
backend/node_modules/date-fns/differenceInBusinessDays.d.ts
generated
vendored
Normal file
@@ -0,0 +1,60 @@
|
||||
import type { ContextOptions, DateArg } from "./types.js";
|
||||
/**
|
||||
* The {@link differenceInBusinessDays} function options.
|
||||
*/
|
||||
export interface DifferenceInBusinessDaysOptions extends ContextOptions<Date> {}
|
||||
/**
|
||||
* @name differenceInBusinessDays
|
||||
* @category Day Helpers
|
||||
* @summary Get the number of business days between the given dates.
|
||||
*
|
||||
* @description
|
||||
* Get the number of business day periods between the given dates.
|
||||
* Business days being days that aren't in the weekend.
|
||||
* Like `differenceInCalendarDays`, the function removes the times from
|
||||
* the dates before calculating the difference.
|
||||
*
|
||||
* @param laterDate - The later date
|
||||
* @param earlierDate - The earlier date
|
||||
* @param options - An object with options
|
||||
*
|
||||
* @returns The number of business days
|
||||
*
|
||||
* @example
|
||||
* // How many business days are between
|
||||
* // 10 January 2014 and 20 July 2014?
|
||||
* const result = differenceInBusinessDays(
|
||||
* new Date(2014, 6, 20),
|
||||
* new Date(2014, 0, 10)
|
||||
* )
|
||||
* //=> 136
|
||||
*
|
||||
* // How many business days are between
|
||||
* // 30 November 2021 and 1 November 2021?
|
||||
* const result = differenceInBusinessDays(
|
||||
* new Date(2021, 10, 30),
|
||||
* new Date(2021, 10, 1)
|
||||
* )
|
||||
* //=> 21
|
||||
*
|
||||
* // How many business days are between
|
||||
* // 1 November 2021 and 1 December 2021?
|
||||
* const result = differenceInBusinessDays(
|
||||
* new Date(2021, 10, 1),
|
||||
* new Date(2021, 11, 1)
|
||||
* )
|
||||
* //=> -22
|
||||
*
|
||||
* // How many business days are between
|
||||
* // 1 November 2021 and 1 November 2021 ?
|
||||
* const result = differenceInBusinessDays(
|
||||
* new Date(2021, 10, 1),
|
||||
* new Date(2021, 10, 1)
|
||||
* )
|
||||
* //=> 0
|
||||
*/
|
||||
export declare function differenceInBusinessDays(
|
||||
laterDate: DateArg<Date> & {},
|
||||
earlierDate: DateArg<Date> & {},
|
||||
options?: DifferenceInBusinessDaysOptions | undefined,
|
||||
): number;
|
Reference in New Issue
Block a user