Update readme with a list of of what type converters support

netglade · Oct 30, 2023 · 246db16 · 246db16
1 parent d51f294
commit 246db16
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/packages/auto_mappr/README.md b/packages/auto_mappr/README.md
@@ -715,6 +715,25 @@ static Value<Object> objectToValueObject2(Object source) {
 }
 ```
 
+To make it more clear, here is a list of type converters
+with an input -> source sublist of what the converter support.
+
+- `TypeConverter<Object, Object>` ... aka `Object converter(Object) => ...`
+  - `Object` -> `Object`
+  - `Object` -> `Object?`
+  - `Object?` -> `Object?`, when source IS NOT null
+- `TypeConverter<Object, Object?>` ... aka `Object? converter(Object) => ...`
+  - `Object` -> `Object?`
+  - `Object?` -> `Object?` when source IS NOT null
+- `TypeConverter<Object?, Object>` ... aka `Object converter(Object?) => ...`
+  - `Object` -> `Object`
+  - `Object?` -> `Object`
+  - `Object` -> `Object?`
+  - `Object?` -> `Object?`
+- `TypeConverter<Object?, Object?>` ... aka `Object? converter(Object?) => ...`
+  - `Object` -> `Object?`
+  - `Object?` -> `Object?`
+
 ### Reverse mapping
 
 When you want to create a bidirectional mapping (e.g. normal: source to target and reversed: target to source),