Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
{
"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",
"deep-readonly",
"domain-modeling",
"immutable",
"nominal-typing",
"parse-dont-validate",
"typescript",
"value-object"
],
Expand Down
Loading