Skip to content

Commit 1cfda13

Browse files
committed
docs: update readmes
Summary: Test Plan: [ghstack-poisoned]
1 parent fa78749 commit 1cfda13

File tree

21 files changed

+82
-21
lines changed

21 files changed

+82
-21
lines changed

README.md

+43-18
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/all/README.md

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/arktype/README.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/class-validator/README.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/effect/README.md

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/function/README.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/io-ts/README.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/joi/README.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/json/README.md

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/main/README.md

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/ow/README.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/runtypes/README.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/superstruct/README.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/suretype/README.md

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/typebox/README.md

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/valibot/README.md

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/valita/README.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/yup/README.md

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/zod/README.md

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
## API
2-
32
{{#if canInfer.output}}
3+
44
### Inference
55
- `Infer<TSchema>`: Extracts the output type of a schema
66
{{#if canInfer.input}}
77
- `InferIn<TSchema>`: Extracts the input type of a schema
88
{{/if}}
99
{{/if}}
1010
{{#if hasModule.validation}}
11+
1112
### Validation
1213
- `wrap(schema)`: Returns the wrapped schema with access to its operations
1314
- `validate(schema, data)`: Returns the validated data or a list of validation issues
1415
- `assert(schema, data)`: Returns the validated data or throws an `AggregateError`
1516
{{/if}}
1617
{{#if hasModule.serialization}}
18+
1719
### Serialization
1820
- `toJSONSchema(schema)`: Converts the schema into the equivalent JSON schema
1921
{{/if}}

turbo/generators/templates/README.md.hbs

+9-2
Original file line numberDiff line numberDiff line change
@@ -64,26 +64,33 @@ We value flexibility, which is why there are multiple ways of using TypeSchema:
6464
<table>
6565
<tr>
6666
<th align="left">Project</th>
67-
<th align="center">Popularity</th>
67+
<th align="left">Popularity</th>
6868
<th align="center"><code>Infer</code></th>
6969
<th align="center"><code>InferIn</code></th>
7070
<th align="center">Validation</th>
7171
<th align="center">Serialization</th>
7272
<th align="left">Adapter</th>
73+
<th align="right">Downloads</th>
7374
</tr>
7475
{{#each libraries}}
7576
<tr>
7677
<td align="left"><nobr><a href="{{url}}" rel="nofollow">{{name}}</a></nobr></td>
77-
<td align="center"><a href="https://github.com/{{github}}" rel="nofollow"><img src="https://img.shields.io/github/stars/{{github}}?style=social" alt="GitHub stars"></a></td>
78+
<td align="left"><a href="https://github.com/{{github}}" rel="nofollow"><img src="https://img.shields.io/github/stars/{{github}}?style=social" alt="GitHub stars"></a></td>
7879
<td align="center">{{icon adapter.canInfer.output}}</td>
7980
<td align="center">{{icon adapter.canInfer.input}}</td>
8081
<td align="center">{{icon adapter.hasModule.validation}}</td>
8182
<td align="center">{{icon adapter.hasModule.serialization}}</td>
8283
<td align="left"><nobr><code><a href="https://github.com/decs/typeschema/tree/main/packages/{{adapter.name}}">@typeschema/{{adapter.name}}</a></code></nobr></td>
84+
<td align="right"><a href="https://www.npmjs.com/package/@typeschema/{{adapter.name}}" rel="nofollow"><img src="https://img.shields.io/npm/dw/@typeschema/{{adapter.name}}.svg?label=" alt="npm downloads"></a></td>
8385
</tr>
8486
{{/each}}
8587
</table>
8688

89+
> [!NOTE]
90+
> Don't see your favorite validation library?
91+
> We welcome [PRs](https://github.com/decs/typeschema/pulls)!
92+
> Otherwise, please [file an issue](https://github.com/decs/typeschema/issues) to help us prioritize. 🙌
93+
8794
{{> readmeAPI adapter}}
8895

8996
## Acknowledgements

0 commit comments

Comments
 (0)