Skip to content

Commit

Permalink
chore(README): Add TS logo on the badge, add bundle size badges and add
Browse files Browse the repository at this point in the history
Features section
  • Loading branch information
takagiy committed Jul 29, 2024
1 parent 1821ddd commit 2437d8e
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,21 @@
<p align="center">
<a href="https://github.com/takagiy/validated-extendable.js/actions/workflows/ci.yaml"><img alt="CI" src="https://github.com/takagiy/validated-extendable.js/actions/workflows/ci.yaml/badge.svg"></a>
<a href="https://opensource.org/licenses/MIT"><img alt="License" src="https://img.shields.io/npm/l/validated-extendable"></a>
<img alt="Written in TypeScript" src="https://img.shields.io/badge/%3C/%3E-TypeScript-3178c6">
<img alt="Written in TypeScript" src="https://img.shields.io/badge/-TypeScript-3178c6?logo=typescript&logoColor=white&labelColor=3178c6">
<a href="https://www.npmjs.com/package/validated-extendable"><img alt="NPM Version" src="https://img.shields.io/npm/v/validated-extendable"></a>
<a href="https://bundlephobia.com/package/validated-extendable"><img alt="npm bundle size" src="https://img.shields.io/bundlephobia/min/validated-extendable"></a>
<a href="https://bundlephobia.com/package/validated-extendable"><img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/validated-extendable"></a>
</p>

## Features

- Defining a class extending a zod schema
- Property types inferred from the schema
- Validation in the constructor
- Both readonly (default) and mutable properties
- Validation in setters of mutable properties
- Wrapping a validated primitive value in a class

## Installation

| npm | pnpm | yarn |
Expand Down

0 comments on commit 2437d8e

Please sign in to comment.