Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xieyuheng/ty
Validate untyped data and return well typed result.
https://github.com/xieyuheng/ty
javascript json-schema schema typescript validator well-typed
Last synced: 9 days ago
JSON representation
Validate untyped data and return well typed result.
- Host: GitHub
- URL: https://github.com/xieyuheng/ty
- Owner: xieyuheng
- License: gpl-3.0
- Created: 2021-08-11T10:49:41.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-26T11:43:40.000Z (2 months ago)
- Last Synced: 2024-12-08T07:42:55.682Z (18 days ago)
- Topics: javascript, json-schema, schema, typescript, validator, well-typed
- Language: TypeScript
- Homepage:
- Size: 457 KB
- Stars: 22
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Authors: AUTHORS
Awesome Lists containing this project
README
# Ty
Validate untyped data and return well typed result.
- This package has no dependencies.
## Install
```bash
npm i @xieyuheng/ty
```
## Examples
### Validation untyped data
```typescript
import ty, { Obtain } from "@xieyuheng/ty"
const userSchema = ty.object({
id: ty.int({ min: 0 }),
first_name: ty.string(),
last_name: ty.string(),
})
type User = Obtain
// NOTE We can extract a `User` type from the type of `userSchema`,
// which will be the same as the following type definition:
// type User = {
// id: number
// first_name: string
// last_name: string
// }
{
const data: any = {
id: 1,
first_name: "Yuheng",
last_name: "Xie",
}
const user: User = userSchema.validate(data)
}
```
### Recursive and generic schema
```typescript
type List = null | { head: T; tail: List }
function cons(head: T, tail: List): List {
return { head, tail }
}
function listSchema(itemSchema: Schema): Schema> {
const nullSchema = ty.null()
const consSchema = ty.object({
head: itemSchema,
tail: ty.lazy(() => listSchema(itemSchema)),
})
return ty.union(nullSchema, consSchema)
}
{
const schema = listSchema(ty.string())
const data0: List = schema.validate(null)
const data1: List = schema.validate(cons("a", null))
const data2: List = schema.validate(cons("a", cons("b", null)))
const data3: List = schema.validate(
cons("a", cons("b", cons("c", null))),
)
schema.expectInvalid(cons(1, null))
schema.expectInvalid(cons(1, cons(2, null)))
schema.expectInvalid(cons(1, cons(2, cons(3, null))))
}
{
const schema = listSchema(ty.number())
const data0: List = schema.validate(null)
const data1: List = schema.validate(cons(1, null))
const data2: List = schema.validate(cons(1, cons(2, null)))
const data3: List = schema.validate(cons(1, cons(2, cons(3, null))))
schema.expectInvalid(cons("a", null))
schema.expectInvalid(cons("a", cons("b", null)))
schema.expectInvalid(cons("a", cons("b", cons("c", null))))
}
```
## API Docs
**Primitive:**
- [ty.string()](src/tests/string.test.ts)
- [ty.url()](src/tests/url.test.ts)
- [ty.date()](src/tests/date.test.ts)
- [ty.number()](src/tests/number.test.ts)
- [ty.int()](src/tests/int.test.ts)
- [ty.boolean()](src/tests/boolean.test.ts)
- [ty.null()](src/tests/null.test.ts)
- [ty.undefined()](src/tests/undefined.test.ts)
- [ty.any()](src/tests/any.test.ts)
**Collection:**
- [ty.object({ ...schemas })](src/tests/object.test.ts)
- [ty.array(itemSchema)](src/tests/array.test.ts)
- [ty.tuple(...itemSchema)](src/tests/tuple.test.ts)
- [ty.dict(itemSchema)](src/tests/dict.test.ts)
**Set-Theoretic:**
- [ty.const(data as const)](src/tests/const.test.ts)
- [ty.union(leftSchema, rigthSchema)](src/tests/union.test.ts)
- [ty.intersection(leftSchema, rigthSchema)](src/tests/intersection.test.ts)
**Structural:**
- [ty.optional(schema)](src/tests/optional.test.ts)
**Recursion:**
- [ty.lazy(() => schema)](src/tests/lazy.test.ts)
## Contributions
To make a contribution, fork this project and create a pull request.
Please read the [STYLE-GUIDE.md](STYLE-GUIDE.md) before you change the code.
Remember to add yourself to [AUTHORS](AUTHORS).
Your line belongs to you, you can write a little
introduction to yourself but not too long.
## License
[GPLv3](LICENSE)