subtractBusinessDays
Signature
Section titled “Signature”subtractBusinessDays(value: string, amount: number): stringimport { subtractBusinessDays } from "@northguild/gmt/plain/calculate";Return a PlainDate ISO string with amount business days subtracted from value.
- Uses fixed ISO Monday–Friday business days (no locale awareness).
- Saturday and Sunday are skipped during the count.
- Negative
amountbehaves identically toaddBusinessDays(value, Math.abs(amount)). - Returns “” on invalid input.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
value |
string |
ISO PlainDate string |
amount |
number |
number of business days to subtract |
Returns
Section titled “Returns”ISO PlainDate string after subtracting business days, or “” on invalid input
Examples
Section titled “Examples”subtractBusinessDays("2024-03-18", 1) // "2024-03-15"subtractBusinessDays("2024-03-17", 1) // "2024-03-15"subtractBusinessDays("2024-03-18", 0) // "2024-03-18"subtractBusinessDays("invalid", 1) // ""