Skip to content

Commit 5941195

Browse files
committed
update README, closes #1116
1 parent 5f2f88d commit 5941195

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ We use [Break Versioning][breakver]. The version numbers follow a `<major>.<mino
1414

1515
Malli is in well matured [alpha](README.md#alpha).
1616

17+
##
18+
19+
* Docs: elaborate optional-keys and required-keys [#1117](https://github.com/metosin/malli/pull/1117)
20+
1721
## 0.17.0 (2024-12-08)
1822

1923
* Don't output `:definitions nil` in swagger. [#1134](https://github.com/metosin/malli/issues/1134)

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,8 @@ Most core-predicates are mapped to Schemas:
331331
; => true
332332
```
333333

334+
*NOTE*: Predicate Schemas do not cover any schema properties, e.g. `string?` can be modified with properties like `:min` and `:max`. If you want to use the schema properties, use real schema types instead, e.g. `:string` over `string?`.
335+
334336
See [the full list of default schemas](#schema-registry).
335337

336338
## Enumeration schemas
@@ -3476,6 +3478,8 @@ The transformation engine is smart enough to just transform parts of the schema
34763478

34773479
Contains both function values and unqualified symbol representations for all relevant core predicates. Having both representations enables reading forms from both code (function values) and EDN-files (symbols): `any?`, `some?`, `number?`, `integer?`, `int?`, `pos-int?`, `neg-int?`, `nat-int?`, `pos?`, `neg?`, `float?`, `double?`, `boolean?`, `string?`, `ident?`, `simple-ident?`, `qualified-ident?`, `keyword?`, `simple-keyword?`, `qualified-keyword?`, `symbol?`, `simple-symbol?`, `qualified-symbol?`, `uuid?`, `uri?`, `decimal?`, `inst?`, `seqable?`, `indexed?`, `map?`, `vector?`, `list?`, `seq?`, `char?`, `set?`, `nil?`, `false?`, `true?`, `zero?`, `rational?`, `coll?`, `empty?`, `associative?`, `sequential?`, `ratio?`, `bytes?`, `ifn?` and `fn?`.
34783480

3481+
*NOTE*: Predicate Schemas do not cover any schema properties, e.g. `string?` can be modified with properties like `:min` and `:max`. If you want to use the schema properties, use real schema types instead, e.g. `:string` over `string?`.
3482+
34793483
### `malli.core/class-schemas`
34803484

34813485
Class-based schemas, contains `java.util.regex.Pattern` & `js/RegExp`.

0 commit comments

Comments
 (0)