# is-it-weekend

> Returns true if it's Saturday or Sunday, otherwise it returns false

Latest version **1.1.0** (published 2017-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-it-weekend
pnpm add is-it-weekend
yarn add is-it-weekend
bun add is-it-weekend
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2017-06-15 |
| First published | 2017-01-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Thomas Watson Steen |
| Maintainers | watson |
| Keywords | date, calendar, weekday, weekend, day, days |

## Links

- npm: https://www.npmjs.com/package/is-it-weekend
- Repository: https://github.com/watson/is-it-weekend
- Homepage: https://github.com/watson/is-it-weekend#readme
- Issues: https://github.com/watson/is-it-weekend/issues
- npm.io page: https://npm.io/package/is-it-weekend

## Alternatives

- [@js-joda/timezone](https://npm.io/package/@js-joda/timezone.md) — 383.4K weekly downloads
- [chartjs-adapter-moment](https://npm.io/package/chartjs-adapter-moment.md) — 210.8K weekly downloads
- [strftime](https://npm.io/package/strftime.md) — 171.2K weekly downloads
- [vue-flatpickr-component](https://npm.io/package/vue-flatpickr-component.md) — 115.8K weekly downloads
- [timepicker](https://npm.io/package/timepicker.md) — 51.0K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2017-06-15
- 1.0.0 — 2017-01-05

## README

# is-it-weekend

Returns `true` if today is a weekend, otherwise it returns `false`.

This module supports weekends that are not on a Saturday or Sunday if a
country code is provided.

[![Build status](https://travis-ci.org/watson/is-it-weekend.svg?branch=master)](https://travis-ci.org/watson/is-it-weekend)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

## Installation

```
npm install is-it-weekend --save
```

## Usage

```js
var weekend = require('is-it-weekend')

// will log `true` if it's Saturday or Sunday
console.log(weekend())
```

## API

### `var bool = weekend([countryCode])`

If no `countryCode` is given, `bool` will be `true` if it's a Saturday
or a Sunday, otherwise `false`.

If a `countryCode` is given, the [custom of that particular
country](https://en.wikipedia.org/wiki/Workweek_and_weekend) will be
followed.

Only [ISO 3166-1
alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes
are supported.

## License

MIT

---
_Source: https://npm.io/package/is-it-weekend · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._