@elyx-code/project-logic-tree 0.0.6935 → 0.0.6936

package/dist/index.d.ts

@@ -9882,9 +9882,22 @@ export declare enum BaseValueDescriptorIds {
 
  /**
   * Checks whether two data-type entities are compatible.
-  * Order matters. In places where one data-type is constrained and the other is not,
-  * the first data-type (dataTypeA) is considered the value writer (source).
-  * while the second data-type (dataTypeB) is considered the value reader (target).
+  *
+  * Order matters. `dataTypeA` is treated as the value writer (source) and
+  * `dataTypeB` as the value reader (target). `compatible: true` means every
+  * possible value of A is acceptable to B (i.e. A ⊆ B). `exact: true`
+  * additionally means A and B describe the same value set (A ≡ B).
+  *
+  * Notable behaviour:
+  *   - `null` represents an unconstrained data-type. An unconstrained side is
+  *     considered compatible with anything (lenient codebase convention).
+  *   - Degenerate single-child or/and-group wrappers (e.g. `[string]`,
+  *     `and[string]`) are transparently collapsed to their child as long as
+  *     the wrapper hasn't overridden `isList`/`asType`. So `string` and
+  *     `[string]` compare exactly equivalent.
+  *   - For or-groups, A is compatible with B iff every option of A fits in B
+  *     (any option of B if B itself is an or-group). The function does NOT
+  *     return `compatible: true` just because some single pair overlaps.
   *
   * @param dataTypeA
   * @param dataTypeB