{"id":22539452,"url":"https://github.com/andr-ll/vator","last_synced_at":"2025-03-28T07:14:10.530Z","repository":{"id":168047886,"uuid":"643666642","full_name":"andr-ll/vator","owner":"andr-ll","description":"Assert validator for TypeScript projects","archived":false,"fork":false,"pushed_at":"2024-04-08T15:00:30.000Z","size":1646,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-13T21:18:30.011Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/vator","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andr-ll.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-05-21T21:51:54.000Z","updated_at":"2024-04-15T16:03:53.756Z","dependencies_parsed_at":null,"dependency_job_id":"a2a6611b-373a-4a86-a248-4421aeec9bb4","html_url":"https://github.com/andr-ll/vator","commit_stats":null,"previous_names":["andr-ii/vator","andr-ll/vator"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andr-ll%2Fvator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andr-ll%2Fvator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andr-ll%2Fvator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andr-ll%2Fvator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andr-ll","download_url":"https://codeload.github.com/andr-ll/vator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245984591,"owners_count":20704798,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-07T12:07:02.323Z","updated_at":"2025-03-28T07:14:10.505Z","avatar_url":"https://github.com/andr-ll.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vator\n\n[![NPM][npm-img]][npm-url]\n[![Build][build-img]][build-url]\n[![Coverage][coverage-img]][coverage-url]\n[![License][license-pic]][license-url]\n[![Downloads][npm-downloads]][npm-url]\n\nAssert validator for TypeScript projects.\n\n## Installation\n\n```bash\nnpm install vator\n```\n\n## Usage\n\n```js\n// ESM or TypeScript projects:\nimport { v, validate, buildSchema, is } from 'vator';\n\n// CommonJS projects:\nconst { v, validate, buildSchema, is } = require('vator');\n```\n\n## Examples\n\n### 'is'\n\n`is` is a collection of shortcuts for comparing types of values.\nThe regular\n\n```ts\nif (value === undefined) {\n  ...\n}\n```\n\ncan be replaced with more convenient\n\n```ts\nif (is.undefined(value)) {\n  ...\n}\n```\n\nDesigned to be used in conditions, because it uses `type guard` approach.\n\n```ts\nconst maybeNumber = Math.random() \u003e 0.5 ? 10 : null;\n\nif (is.number(maybeNumber)) {\n  // TS will not complain, because maybeNumber is number already\n  console.log(maybeNumber + 10); // 20\n} else {\n  console.log(maybeNumber === null); // true\n}\n```\n\nAvailable `is` validators:\n\n```ts\nis.undefined();\nis.null();\nis.nullable();\nis.string();\nis.number();\nis.email();\nis.phone();\n```\n\n### Primitives with 'validate'\n\nWill validate that `value` is a string type:\n\n```ts\nconst value = 'some';\n\nvalidate(value, v.string);\n```\n\nWill throw an error if value is not matching the type:\n\n```ts\nconst value = 22;\n\nvalidate(value, v.string);\n```\n\nError:\n\n```log\nValidation failed: value has type 'number', but 'string' type is required.\n```\n\n### Objects and Arrays with 'validate'\n\nWill validate that `value` is an object with described fields.\nAlso it's more convenient to use `buildSchema` helper to get `schema` and `ResultType`.\n\n\u003e **Note**\n\u003e\n\u003e `ReturnType` is an empty object, only refers to valid result type!.\n\n```ts\n// Let's pretend that 'value' is 'unknown' type\nconst value: unknown = {\n  name: 'some-name',\n  age: 100,\n  isOnline: false,\n  updatedAt: '2023-05-22T14:32:34.324Z',\n  unknownData: [2, 'foo', false]\n  cars: [\n    {\n      model: 'bmw',\n      year: 2017\n    },\n    {\n      model: 'audi',\n      year: null\n    }\n  ]\n};\n\nconst { schema, ResultType } = buildSchema({\n  name: v.string,\n  age: v.optional.number,\n  isOnline: v.maybe.boolean,\n  updatedAt: v.Date,\n  unknownData: v.unknown,\n  cars: v.array(v.object({\n    model: v.literal('bmw', 'audi'),\n    year: v.nullable.number\n  }))\n});\n\nvalidate(value, schema)\n```\n\nAlso `value` will then have valid types (because `validate()` asserts them)\n\n![Alt text](./assets/vator-example.png)\n\n[npm-img]: https://img.shields.io/npm/v/vator.svg?logo=npm\n[npm-url]: https://www.npmjs.com/package/vator\n[npm-downloads]: https://img.shields.io/npm/dt/vator?logo=Hack%20The%20Box\u0026logoColor=green\u0026label=downloads\n[build-img]: https://img.shields.io/github/actions/workflow/status/andr-ii/vator/build.yml?logo=github\n[build-url]: https://github.com/andr-ii/vator/actions/workflows/build.yml\n[coverage-img]: https://img.shields.io/coverallsCoverage/github/andr-ii/vator?label=coverage\u0026logo=jest\n[coverage-url]: https://coveralls.io/github/andr-ii/vator?branch=master\n[license-pic]: https://img.shields.io/github/license/andr-ii/vator?color=blue\u0026label=%C2%A9%20license\n[license-url]: https://github.com/andr-ii/vator/blob/master/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandr-ll%2Fvator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandr-ll%2Fvator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandr-ll%2Fvator/lists"}