feat(text-canvas): add FMT_NONE dummy formatter

erik-krogh · Mar 23, 2021 · 0b1f3bd · 0b1f3bd
1 parent 4e171db
commit 0b1f3bd
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/packages/text-canvas/src/string.ts b/packages/text-canvas/src/string.ts
@@ -21,9 +21,20 @@ import {
 import type { Canvas } from "./canvas";
 
 /**
- * Returns string representation of canvas, optionally using given
- * string formatter. If none is given, returns plain string
- * representation, ignoring any character format data.
+ * Convenience {@link StringFormat} which ignores any formatting and results in
+ * plain text.
+ */
+export const FMT_NONE: StringFormat = {
+    prefix: "",
+    suffix: "",
+    start: () => "",
+    end: "",
+};
+
+/**
+ * Returns string representation of canvas, optionally using given string
+ * formatter. If none is given, returns plain string representation, ignoring
+ * any character format data.
  *
  * @param canvas
  * @param format