Document LogEntryCharMaps type

TNO · Sep 26, 2023 · 0b06de9 · 0b06de9
1 parent 8d0c63e
commit 0b06de9
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/developer-documentation/types/LogEntryCharMaps.md b/docs/developer-documentation/types/LogEntryCharMaps.md
@@ -0,0 +1,10 @@
+# Name
+
+```TS
+interface LogEntryCharMaps {
+	firstCharIndexMap;
+	lastCharIndexMap;
+}
+```
+
+This type is used to represent an object containing two JavaScript [`Map`(s)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map). These maps store the first and last char indices of each log entry. These indices are used for the Segment Annotation and Structure Matching features and Search (with Regular Expressions).