# types-verifier

> A super tiny library that verifies types

Latest version **1.0.0-alpha.2** (published 2018-11-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install types-verifier
pnpm add types-verifier
yarn add types-verifier
bun add types-verifier
```

## 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.0.0-alpha.2 |
| Published | 2018-11-28 |
| First published | 2018-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Joey Jiron |
| Maintainers | joeyjiron06 |
| Keywords | types-verifier, prop-types, types-validator, types, validator, check-type, type-checking, type-checker |

## Links

- npm: https://www.npmjs.com/package/types-verifier
- Repository: https://github.com/joeyjiron06/types-verifier
- Homepage: https://github.com/joeyjiron06/types-verifier#readme
- Issues: https://github.com/joeyjiron06/types-verifier/issues
- npm.io page: https://npm.io/package/types-verifier

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.0-alpha.2 (latest) — 2018-11-28
- 1.0.0-alpha.1 — 2018-11-28

## README

# types-verifier

[![Build Status](https://cloud.drone.io/api/badges/joeyjiron06/types-verifier/status.svg)](https://cloud.drone.io/joeyjiron06/types-verifier)
[![codecov](https://codecov.io/gh/joeyjiron06/types-verifier/branch/master/graph/badge.svg)](https://codecov.io/gh/joeyjiron06/types-verifier)


A super lightweight runtime type checking for javascript values ands objects. Very similar to [prop-types](https://github.com/facebook/prop-types), expect that this package solves [this issue](https://github.com/facebook/prop-types/issues/34) with `prop-types`.


You can use types-verifier verify against the type definitions, and return an error if they don’t match.

## Installation

```
npm install --save types-verifier
```

## Importing

```javascript
import Types from 'types-verifier'; // ES6
var Types = require('types-verifier'); // ES5 with npm
```

## Usage

Here is an example usage of `types-verifier` which also documents the different validators provided.

```javascript
import Types from 'types-verifier';

const UserType = {
  // You can declare that a prop is a specific JS primitive. By default, these
  // are all optional. To make it required just add .isRequired to any validator
  array: Types.array,
  bool: Types.bool,
  func: Types.func,
  number: Types.number,
  object: Types.object,
  string: Types.string,

  // You can ensure that your prop is limited to specific values by treating
  // it as an enum.
  enum: Types.oneOf(['News', 'Photos']),

  // An array of a certain type
  arrayOf: Types.arrayOf(Types.number),


  
  // An object taking on a particular shape
  objectWithShape: Types.shape({
    property: Types.string,
    requiredProperty: Types.number.isRequired
  }),


  //
  requiredFunc: Types.func.isRequired,

  // A value of any data type
  requiredAny: Types.any.isRequired,


  // You can also specify a custom verifier. It should return an Error
  // object if the validation fails. Don't `console.warn` or throw;
  // it should return null if verification succeeds.
  customProp: Types.create function(value, propName) {
    if (!/matchme/.test(value)) {
      return new TypeError(`${propName} must matchme, but you supplied ${String(value)}`);
    }

    return null;
  }
};

const result = Types.checkTypes(UserType, {
  hello: 'world'
});

// result will be a TypeError with a message of ALL the errors describing why
// the object does not match the type definition
```


## Motivation

I would love to use [prop-types](https://github.com/facebook/prop-types) from facebook because it's a very solid peice of code. The main issue that that it cannot be easily used outside for react - see the issue [here](https://github.com/facebook/prop-types/issues/34). In a nutshell, `prop-types` returns "shims" (no-op functions that don't do anything) when in production mode, which is does not support all use cases.

There are plenty of other libraries that are trying to solve the same problem as `prop-types`, but none of them quite fit my needs. Here are the projects I found:

https://github.com/hustcc/variable-type
https://github.com/dbrekalo/validate-types
https://github.com/andnp/ValidTyped
https://github.com/david-martin/types-validator

Those projects are great, but I really need a validator like `prop-types` that will return ALL the error messages when I check on object againts a type definition. When debugging and finding out what is wrong with your software, it is VERY helpful to have really good error messages, which is why I love `prop-types` so much. None of the libraries above give you all the errors. That is why i decided to create this package.

## Tech Stack

- [drone.io](https://cloud.drone.io) for CI/CD
- [jest](https://jestjs.io/) for testing 
- [eslint](https://eslint.org/) for linting
- [codecov](https://codecov.io/) for code coverage

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