feature(bbcode-dataprocessor): Provide a check if an error is a Conte…

…xtMismatchError

packages/ckeditor5-data-facade/__tests__/ContextMismatchError.test.ts

@@ -1,4 +1,4 @@
-import { ContextMismatchError } from "../src/ContextMismatchError";
+import { ContextMismatchError, isContextMismatchError } from "../src/ContextMismatchError";
 
 describe("ContextMismatchError", () => {
   it("should be possible to instantiate the error without a message", () => {
@@ -48,4 +48,12 @@ describe("ContextMismatchError", () => {
     expect(error).toHaveProperty("actual", actual);
     expect(error).toHaveProperty("expected", expected);
   });
+
+  it("should be possible to check if an error is a ContextMismatchError", () => {
+    const error = new ContextMismatchError();
+    expect(isContextMismatchError(error)).toBe(true);
+
+    const anyError = new Error("This is any error and the typeguard should return false");
+    expect(isContextMismatchError(anyError)).toBe(false);
+  });
 });

packages/ckeditor5-data-facade/src/ContextMismatchError.ts

@@ -29,3 +29,11 @@ export class ContextMismatchError extends Error {
     return `ContextMismatchError: ${this.message} {actual=${this.actual}, expected=${this.expected}}`;
   }
 }
+
+/**
+ * Typeguard to check if an error is a `ContextMismatchError`.
+ *
+ * @param error - the error to check
+ */
+export const isContextMismatchError = (error: unknown): error is ContextMismatchError =>
+  error instanceof ContextMismatchError;

packages/ckeditor5-data-facade/src/index.ts

@@ -2,7 +2,7 @@
  * @module ckeditor5-data-facade
  */
 
-export { ContextMismatchError } from "./ContextMismatchError";
+export { ContextMismatchError, isContextMismatchError } from "./ContextMismatchError";
 
 export type { DataApi, GetDataApi, SetDataApi } from "./DataApi";
 
@@ -25,4 +25,5 @@ export type { DataFacadeConfig, Save } from "./DataFacadeConfig";
 
 export { DataFacadeController } from "./DataFacadeController";
 
+
 import "./augmentation";