# the-check

> Check utility for the-framework

Latest version **2.0.23** (published 2019-02-24) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install the-check
pnpm add the-check
yarn add the-check
bun add the-check
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.23 |
| Published | 2019-02-24 |
| First published | 2017-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 6 |
| Unpacked size | 72.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | the |

## Links

- npm: https://www.npmjs.com/package/the-check
- Repository: https://github.com/the-labo/the-check
- Homepage: https://github.com/the-labo/the-check#readme
- Issues: https://github.com/the-labo/the-check/issues
- npm.io page: https://npm.io/package/the-check

## Dependencies (6)

- [asenv](https://npm.io/package/asenv.md) ^3.0.1
- [bowser](https://npm.io/package/bowser.md) ^2.1.0
- [hasbin](https://npm.io/package/hasbin.md) ^1.2.3
- [the-window](https://npm.io/package/the-window.md) ^7.0.3
- [os-browserify](https://npm.io/package/os-browserify.md) ^0.3.0
- [path-browserify](https://npm.io/package/path-browserify.md) ^1.0.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 2.0.23 (latest) — 2019-02-24
- 2.0.22 — 2019-02-24
- 2.0.21 — 2019-02-24
- 2.0.20 — 2019-02-24
- 2.0.19 — 2019-02-24
- 2.0.18 — 2018-12-29
- 2.0.17 — 2018-12-08
- 2.0.16 — 2018-11-16
- 2.0.13 — 2018-11-12
- 2.0.12 — 2018-10-31
- 2.0.11 — 2018-10-31
- 2.0.10 — 2018-10-07
- 2.0.8 — 2018-10-01
- 2.0.6 — 2018-09-28
- 2.0.5 — 2018-09-25
- … 15 more at https://npm.io/package/the-check/versions

## README

the-check
==========

<!---
This file is generated by the-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/the-labo/the-check
[bd_travis_url]: http://travis-ci.org/the-labo/the-check
[bd_travis_shield_url]: http://img.shields.io/travis/the-labo/the-check.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/the-labo/the-check
[bd_travis_com_shield_url]: https://api.travis-ci.com/the-labo/the-check.svg?token=
[bd_license_url]: https://github.com/the-labo/the-check/blob/master/LICENSE
[bd_npm_url]: http://www.npmjs.org/package/the-check
[bd_npm_shield_url]: http://img.shields.io/npm/v/the-check.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Check utility for the-framework

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install the-check --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const { unlessProduction } = require('the-check')

async function tryExample () {

  function myFunc (someArg) {
    // Run check only if `process.env.NODE_ENV !=== 'production'`
    unlessProduction(({ ok, equal }) => {
      ok(someArg, 'someArg is required!')
      equal(typeof someArg === 'string', 'someArg must be a string!')
    })
  }

  myFunc('hoge')
}

tryExample().catch((err) => console.error(err))

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/10.API Guide.md.hbs" Start -->

<a name="section-doc-guides-10-a-p-i-guide-md"></a>

API Guide
-----

+ [the-check@2.0.23](./doc/api/api.md)
  + [canTouch()](./doc/api/api.md#the-check-function-can-touch)
  + [hasBin(binName, options)](./doc/api/api.md#the-check-function-has-bin)
  + [isBrowser()](./doc/api/api.md#the-check-function-is-browser)
  + [isChrome()](./doc/api/api.md#the-check-function-is-chrome)
  + [isFirefox()](./doc/api/api.md#the-check-function-is-firefox)
  + [isiOS()](./doc/api/api.md#the-check-function-isi-o-s)
  + [isMacOS()](./doc/api/api.md#the-check-function-is-mac-o-s)
  + [isProduction()](./doc/api/api.md#the-check-function-is-production)
  + [unlessProduction(handler)](./doc/api/api.md#the-check-function-unless-production)


<!-- Section from "doc/guides/10.API Guide.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the-check/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][t_h_e_labo_url]

[t_h_e_labo_url]: https://github.com/the-labo

<!-- Links End -->

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