chore: mark isCompatibleType as unstable

lawvs · Feb 25, 2024 · e87ac5d · e87ac5d
1 parent ed6f5b4
commit e87ac5d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,3 @@
 export { isSameType } from "./is-same-type.ts";
 export { isCompatibleType } from "./is-compatible-type.ts";
-export type { IsSameTypeOptions as CompareOptions } from "./utils.ts";
+export type { IsSameTypeOptions } from "./utils.ts";
diff --git a/src/is-compatible-type.ts b/src/is-compatible-type.ts
@@ -8,6 +8,8 @@ import {
 /**
  * Check if a the higherType matches the lowerType
  *
+ * @deprecated This a unstable API and still in development
+ *
  * @param higherType The looser type
  * @param lowerType The stricter type
  *