update doc

robturtle · Dec 10, 2019 · 5ad4aed · 5ad4aed
1 parent c93f15e
commit 5ad4aed
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.9.0
+
+- supports `enumSchema`
+- supports registering with `CasterBuilder`
+- renames `Builder` to `ClassBuilder`
+
 ## 1.8.0
 
 - supports union types

diff --git a/README.md b/README.md
@@ -134,6 +134,22 @@ export const casters = {
 };
 ```
 
+### Enum types
+
+You can easily register an enum using `enumSchema`
+
+```typescript
+import { enumSchema } from 'io-interface';
+
+enum Status {
+  Pending = 'pending',
+  Complete = 'complete',
+}
+
+decoder.register(enumSchema('Status', Status));
+const status = decoder.decode<Status>('Status', 'pending');
+```
+
 ### Attach custom values
 
 Sometimes you want attach some custom values onto the object. You can do it via the magical attribute `attrs`. If a field of the interface is named `attrs`, it will bypass the validation and be assigned as an empty object. So you should declare all fields inside `attrs` as **optional** since they're empty from the data source in the first place.