https://github.com/biyuehu/tsukiko
Types Check And Parse In The Runtime Base On TypeScript
https://github.com/biyuehu/tsukiko
dto dto-generator dto-pattern tools type-checker types typescript utils zod
Last synced: 10 months ago
JSON representation
Types Check And Parse In The Runtime Base On TypeScript
- Host: GitHub
- URL: https://github.com/biyuehu/tsukiko
- Owner: BIYUEHU
- License: gpl-3.0
- Created: 2023-12-01T07:49:43.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-24T12:15:29.000Z (almost 2 years ago)
- Last Synced: 2024-11-19T04:00:18.740Z (over 1 year ago)
- Topics: dto, dto-generator, dto-pattern, tools, type-checker, types, typescript, utils, zod
- Language: TypeScript
- Homepage:
- Size: 242 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Tsukiko
  
**⚡ Dynamic Types Cheker At Runtime Which Develop Base On TypeScript ⚡**
[Tsukiko Docs](docs/README.md)
## 📃 Install
- NPM
```bash
npm install tsukiko
```
- YAYN
```bash
yarn add tsukiko
```
- PNPM
```bash
pnpm install tsukiko
```
## 🎯 Internationalization
- English
- 日本語 (Japanese)
- 繁體中文 (Traditional Chinese)
- 简体中文（Simplified Chinese）
## 🚀 Parser
- `NumberParser`
- `StringParser`
- `BooleanParser`
- `NullParser`
- `UndefinedParser`
- `AnyParser`
- `UnknownParser`
- `NeverParser`
- `ArrayParser`
- `TupleParser`
- `ObjectParser`
- `EnumParser`
- `LiteralParser`
- `IntersectionParser`
- `UnionParser`
- `CustomParser`
- `FunctionParser`
- `ClassParser`
## 🛠️ Tools
- ParserInfer
- tsuFactory
- TsuError
## 📝 Json-Schema
All parsers' methods which are supported list:
- `NumberParser`
- `int()`
- `multiple()`
- `natural()`
- `positive()`
- `negative()`
- `percent()`
- `port()`
- `StringParser`
- `regexp()`
- `email()`
- `domain()`
- `url()`
- `max()`
- `min()`
- `range()`
- `BooleanParser`
- Fully support
- `NullParser`
- Fully support
- `ArrayParser`
- Fully support
- `TupleParser`
- Fully support
- `ObjectParser`
- `strict()`
- `index()`
- `max()`
- `min()`
- `range()`
- `EnumParser`
- Only support literal values (string, number, boolean constants)
- `LiteralParser`
- Fully support
- `IntersectionParser`
- Fully support
- `UnionParser`
- Fully support
The parsers and methods which no listed are all not supported.
## 🌰 Example
```typescript
// example/example1.ts
import Tsu, { tsuFactory } from "tsukiko";
const schema = Tsu.Tuple([Tsu.Number()]);
export type Schema = Tsu.infer;
const schema2 = Tsu.Array(Tsu.String());
export type Schema2 = Tsu.infer;
const schema3 = Tsu.Object({
value: Tsu.Number(),
name: schema2,
host: Tsu.String().regexp(/http(s)?:\/\/(.*)/),
port: Tsu.Number().range(1, 65565).int(),
allowList: Tsu.Array(Tsu.String()),
listType: Tsu.Union([Tsu.Literal("include"), Tsu.Literal("exclude")]),
});
export type Schema3 = Tsu.infer;
const schema4 = Tsu.Intersection([Tsu.Number(), Tsu.Literal(1)]);
export type Schema4 = Tsu.infer;
const schema5 = Tsu.Intersection([
Tsu.Literal("hello world"),
Tsu.Union([schema, Tsu.Union([Tsu.Number().optional(), schema2])]),
]);
export type Schema5 = Tsu.infer;
const schema6 = Tsu.Object({}).index(
Tsu.String().regexp(/[0-9]+\.[0-9]+\.[0-9]+/),
Tsu.String().regexp(/kotori-plugin-(.*)/)
);
export type Schema6 = Tsu.infer;
export const example6: Schema6 = {
"kotori-plugin-adapter-qq": "1.5.0",
"kotori-plugin-adapter-wechat": "0.2.0",
"kotori-plugin-database-sqlite": "2.1.0",
"kotori-plugin-database-mysql": "3.1.0",
"kotori-plugin-help": "1.2.0",
"kotori-plugin-wiki": "1.0.0",
};
const newTsu = tsuFactory("ja_JP");
export const localeTypeSchema = newTsu.Union([
newTsu.Union([newTsu.Literal("en_US"), newTsu.Literal("ja_JP")]),
newTsu.Union([newTsu.Literal("zh_CN"), newTsu.Literal("zh_TW")]),
]);
const globalConfigBaseSchema = newTsu.Object({
lang: localeTypeSchema.default("ja_JP"),
"command-prefix": newTsu.String().default("/"),
});
const adapterConfigBaseSchema = newTsu.Intersection([
newTsu.Object({
extends: newTsu.String(),
master: newTsu.Union([newTsu.Number(), newTsu.String()]),
}),
globalConfigBaseSchema,
]);
export const globalConfigSchema = newTsu.Object({
global: globalConfigBaseSchema,
adapter: newTsu.Object({}).index(adapterConfigBaseSchema).default({}),
plugin: newTsu.Object({}).index(newTsu.Unknown()).default({}),
});
export type GlobalConfig = Tsu.infer;
console.log(
globalConfigSchema.parse({
global: { lang: "zh_CN" },
adapter: { aa: { master: "1", lang: "ja_JP" } },
})
);
```