feat(types): Add SearchResult type

This commit adds the SearchResults type which contains the type of
search results found when searching for a string in a Trie

README.md

@@ -57,9 +57,9 @@ for (let i = 0; i < searches.length; i += 1) {
 	// There was a match. Print match info
 	if (result) {
 		switch (result.matchType) {
-			case PERFECT_MATCH:
-			case PURE_PREFIX:
-			case PREFIX:
+			case "PERFECT_MATCH":
+			case "PURE_PREFIX":
+			case "PREFIX":
 				console.log(`${searches[i]}: Present in trie`);
 		}
 	}

src/index.ts

@@ -1,2 +1 @@
-export * from "./greet.js";
 export * from "./types.js";

src/types.ts

@@ -1,5 +1,28 @@
-export interface GreetOptions {
-	logger?: (message: string) => void;
-	message: string;
-	times?: number;
-}
+/**
+ * Represents a search for a string that
+ * successfully ends at a leaf node.
+ */
+export type PERFECT_MATCH = {
+	matchType: "PERFECT_MATCH";
+};
+
+/**
+ * Represents a search for a string that
+ * successfully ends at a non-leaf node.
+ */
+export type PURE_PREFIX = {
+	matchType: "PURE_PREFIX";
+};
+/**
+ * Represents a search for a string that
+ * is successful. Not strictly necessary
+ * but useful as the disjunction of
+ * PERFECT_MATCH and PURE_PREFIX.
+ */
+export type PREFIX = {
+	matchType: "PREFIX";
+};
+/**
+ * Union type of all possible values of Trie SearchResult
+ */
+export type SearchResult = PERFECT_MATCH | PURE_PREFIX | PREFIX | undefined;