# @types/next-biz-date

> TypeScript definitions for next-biz-date

Latest version **2.1.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/next-biz-date
pnpm add @types/next-biz-date
yarn add @types/next-biz-date
bun add @types/next-biz-date
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.3 |
| Published | 2023-11-07 |
| First published | 2020-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51442 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/next-biz-date
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/next-biz-date
- npm.io page: https://npm.io/package/@types/next-biz-date

## Dependencies (1)

- [moment](https://npm.io/package/moment.md) ^2.29.1

## Recent versions

- 2.1.3 (latest) — 2023-11-07
- 2.1.0 (ts3.3) — 2020-12-22
- 2.1.2 — 2023-10-18
- 2.1.1 — 2023-09-23

## README

# Installation
> `npm install --save @types/next-biz-date`

# Summary
This package contains type definitions for next-biz-date (https://github.com/janunezc/next-biz-date#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/next-biz-date.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/next-biz-date/index.d.ts)
````ts
import { Moment } from "moment";
/**
 * Returns the next applicable business day for a given candidate day.
 * If candidateDate is a business day then it returns the same provided candidateDate.
 * @param candidateDate Date to evaluate first for being bizdate (moment or string on yyyy-mm-dd format)
 * @param holidaysArray Array of holidays (strings on yyyy-mm-dd format)
 * @param direction FORWARD or BACKWARDS
 */
export function FindBizDate(candidateDate: Moment, holidaysArray: string[], direction?: Direction): Moment;

/***
 * Calculates next applicable business day out of counting bizdates starting from a provided base date up to a provided countTarget by skipping holidays and weekends.
 * @param baseDate date to start counting. Also conceptualized as day 0.
 * @param holidaysArray Array of holidays to consider.
 * @param [countTarget] Number of biz dates count.
 * @param [direction] FORWARD or BACKWARDS to count to the future or to the past respectively.
 */
export function FindNextBizDate(
    baseDate: string,
    holidaysArray: string[],
    countTarget?: number,
    direction?: Direction,
): Moment;

/**
 * count to the future or to the past respectively
 */
export type Direction = "FORWARD" | "BACKWARDS";

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [moment](https://npmjs.com/package/moment)

# Credits
These definitions were written by [Piotr Błażejewicz](https://github.com/peterblazejewicz).

---
_Source: https://npm.io/package/@types/next-biz-date · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._