From c4091f328a7e335e8a276afc2fedb1d9656fd261 Mon Sep 17 00:00:00 2001 From: Joichiro Hayashi Date: Fri, 25 Sep 2026 08:06:27 +0900 Subject: [PATCH 1/2] docs: describe valof as a library for branded, immutable domain types --- README.md | 4 ++-- docs/src/introduction.md | 4 ++-- package.json | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7ea3646..ae2402f 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ npm install valof ## Why Valof? -Valof is an opinionated value-object helper for TypeScript that enforces the conventions through -types and linting. +Valof is a TypeScript library for branded, immutable domain types, such as value objects and enums. +It enforces the conventions through types and linting. - **Nominal-ish typing with a phantom brand**: TypeScript distinguishes one Val type from another, with nothing to pay at runtime. diff --git a/docs/src/introduction.md b/docs/src/introduction.md index af38f03..08706c0 100644 --- a/docs/src/introduction.md +++ b/docs/src/introduction.md @@ -17,8 +17,8 @@ the sidebar to find a specific topic. ## Why Valof? -Valof is an opinionated value-object helper for TypeScript that enforces the conventions through -types and linting. +Valof is a TypeScript library for branded, immutable domain types, such as value objects and enums. +It enforces the conventions through types and linting. - **Nominal-ish typing with a phantom brand**: TypeScript distinguishes one Val type from another, with nothing to pay at runtime. diff --git a/package.json b/package.json index 4b3b15d..94995e4 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "valof", "version": "0.8.2", - "description": "Value-object helpers for TypeScript: branded types, a constructor and a companion, kept as plain data. Starts from 852 B gzipped.", + "description": "Branded, immutable domain types for TypeScript: a constructor and a companion per type, kept as plain data. Starts from 852 B gzipped.", "keywords": [ "branded-types", "ddd", From 83a1cd6b8b3e9d0ef12bf425f6c528015f991f7e Mon Sep 17 00:00:00 2001 From: Joichiro Hayashi Date: Fri, 25 Sep 2026 08:14:27 +0900 Subject: [PATCH 2/2] chore: add keywords for domain modeling, deep readonly and parsing --- package.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/package.json b/package.json index 94995e4..f4cc9b6 100644 --- a/package.json +++ b/package.json @@ -5,8 +5,11 @@ "keywords": [ "branded-types", "ddd", + "deep-readonly", + "domain-modeling", "immutable", "nominal-typing", + "parse-dont-validate", "typescript", "value-object" ],