{"id":18653320,"url":"https://github.com/hanlindev/interface-validator","last_synced_at":"2026-05-13T21:36:34.833Z","repository":{"id":57275192,"uuid":"87648698","full_name":"hanlindev/interface-validator","owner":"hanlindev","description":"Validate JSON objects with TypeScript-like interface specifications.","archived":false,"fork":false,"pushed_at":"2018-01-24T12:01:02.000Z","size":7,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-28T06:41:29.168Z","etag":null,"topics":["instanceof-interface","json-objects","nested-interface","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hanlindev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-08T16:42:31.000Z","updated_at":"2020-07-27T10:56:28.000Z","dependencies_parsed_at":"2022-09-16T11:13:01.176Z","dependency_job_id":null,"html_url":"https://github.com/hanlindev/interface-validator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hanlindev/interface-validator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanlindev%2Finterface-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanlindev%2Finterface-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanlindev%2Finterface-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanlindev%2Finterface-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hanlindev","download_url":"https://codeload.github.com/hanlindev/interface-validator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanlindev%2Finterface-validator/sbom","scorecard":{"id":454605,"data":{"date":"2025-08-11","repo":{"name":"github.com/hanlindev/interface-validator","commit":"49ef7b76664355bede8efd2002d0d25e2b0f4976"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Code-Review","score":0,"reason":"Found 0/6 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-19T09:13:18.216Z","repository_id":57275192,"created_at":"2025-08-19T09:13:18.216Z","updated_at":"2025-08-19T09:13:18.216Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33001369,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"ssl_error","status_checked_at":"2026-05-13T13:14:51.610Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["instanceof-interface","json-objects","nested-interface","typescript"],"created_at":"2024-11-07T07:11:08.681Z","updated_at":"2026-05-13T21:36:34.809Z","avatar_url":"https://github.com/hanlindev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Interface Validator\n=========\n\nValidate JSON objects with TypeScript-like interface specifications.\n\n## Installation\n\n  `npm install interface-validator`\n\n## Usage\nSpecify TypeScript-like interface definition:\n```javascript\nconst Product = {\n  name: 'string!',\n  price: 'number!',\n  'description?': 'string'\n};\n```\n\n```javascript\nimport {getMismatchedFields, validate} from 'interface-validator';\n\nconst invalidItem = {\n  name: '',\n  price: '100'\n}\nconst mismatched = getMismatchedFields(invalidItem, Product);\nconst isValid = valid(invalidItem, Product);\n// Result:\n// mismatched = ['name']\n// isValid = false\n// item = {\n//   name: undefined,\n//   price: 100\n// }\n```\n\n## Types\nValues are checked by this simple statement:\n```javascript\ntypeof value === specType\n```\n\n**Supported types** include:\n* string\n* number\n* boolean\n* object\n* nested interface\n\n**Nested interface** definition is supported. E.g\n```javascript\nconst Product = {\n  name: 'string!',\n  price: {\n    value: 'number!',\n    currency: 'string!'\n  },\n  'description?': 'string'\n}\n```\n\n**Type enforcing**:\nYou can append `!` to the type names to indicate you want to cast the values to\nthe specified types before checking. The tested object's fields will be modified\nto contain the typecasted values. Refer to the above example to see the effect.\n\nThere are some special cases:\n* number!: if the converted value is `NaN` or `Infinity`, the value will be set\nto `undefined`\n* boolean!: only 'true' and 'false' will be converted to boolean. All other\nvalues will be set to `undefined`.\n* string!: if the value is empty string, it will be set to undefined.\n\n**Optional fields** are indicated with a question mark after the field name,\nlike `'description?'`;\n\n## When to use this\nThere are many powerful validation libraries out there. This library is not\nmeant to rival their functionalities. Instead, this is intended to perform very\nsimple run-time interface checks.\n\nIn TypeScript you can put compile-time contract on JSON objects using\n`interface` but they are stripped away at run-time. So there is no way to\nperform `obj instanceof Interface` even when using TypeScript. Not to mention\nplain Javascript where there is no concept of an interface.\n\nSo when you want to do just `object instanceof Interface`, use this library.\nAny slightly more complex cases should be handled by more sophisticated\nlibraries.\n\n## Contribute\nReport issues or submit pull requests.\n\n## Tests\n  `npm test`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhanlindev%2Finterface-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhanlindev%2Finterface-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhanlindev%2Finterface-validator/lists"}