You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| objectName | String | 'Obj' | This is the object name when presented in the path. ie... "Obj.foo" ignored if hidePath is true |
63
+
| prefilter |\[String\]\|Func || see [prefiltering](#prefiltering)|
64
+
| dateFormat | String | 'MM/dd/yyyy hh:mm a' | dateFns format string see [below](#support-for-dates)|
65
+
| ignoreArrays | Bool | false | If array differences aren't needed. Set to true and skip processing |
66
+
| templates | Object | see [templates](#custom-templates)| Completely customize the output. |
67
+
| sensitivePaths |\[String\]|| Paths that will use the sensitive field templates if they are defined |
67
68
68
69
### Custom Templates
69
70
@@ -96,9 +97,9 @@ Where N is a new key, D is a deleted key, E is an edited key, I is an inserted a
96
97
97
98
We also expose a sensitiveFields array option which will cause a path to use the S option template.
98
99
99
-
You can define each sentence in templates to be whatever you'd like them to be and you can use the following codes that will be replaced by their diff values in the final output.
100
+
You can define each sentence in the templates to be whatever you'd like. The following tokens can be used to replace their diff values in the final output.
100
101
101
-
The available values you can plug in to your sentences are `FIELD`, `DOTPATH`,`NEWVALUE`,`OLDVALUE`, `INDEX`, `POSITION`. Position is just index+1. Be aware that not all sentence types will have values for each token. For instance nonarray changes will not have a position or an index.
102
+
The available tokens that can plug in to your sentence templates are `FIELD`, `DOTPATH`,`NEWVALUE`,`OLDVALUE`, `INDEX`, `POSITION`. Position is just index+1. Be aware that not all sentence types will have values for each token. For instance, non-array changes will not have a position or an index.
0 commit comments