Skip to content

update readME #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Many0nne merged 1 commit into from
Mar 3, 2026
Merged

update readME #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ All endpoints are documented with examples and you can test them directly from y

---

## 🎯 Field Constraints with JSDoc Annotations
## Field Constraints with JSDoc Annotations

Add validation constraints to your interfaces using JSDoc annotations. This ensures generated mock data follows your API rules.

Expand Down Expand Up @@ -159,7 +159,7 @@ export interface User {
/** @minLength 3 @maxLength 20 */
username: string;

/** @pattern ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ */
// not needed, email is one of the types handled by intermock
email: string;

/** @min 18 @max 120 */
Expand Down