@astryxdesign/cli 0.7.2-canary.ebcc404 → 0.7.2-canary.f2b60a0

package/foundation/discovery/type-match.d.mts

@@ -0,0 +1,53 @@
+// @generated by scripts/sync-api-types.mjs from the JSDoc in foundation/**/*.mjs.
+// DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
+
+/**
+ * Judge a documented type. A doc may name an alias and spell out what it
+ * stands for, as `Name = expansion` or `Name (expansion)` (text that is not a
+ * type by itself): both parts are judged, and a mismatch in either is one;
+ * with one value after it (`Size = 'md'`, `Size = Size.Md`), or after a
+ * keyword, that part may be a default, and only the name is judged.
+ * @param {string} docType
+ * @param {any[]} codeTypes the prop's type in each member of the props type
+ * @param {JudgeContext} ctx
+ * @returns {TypeVerdict}
+ */
+export function judgeType(docType: string, codeTypes: any[], ctx: JudgeContext): TypeVerdict;
+export type TypeVerdict = "match" | "mismatch" | "not_compared";
+export type JudgeContext = {
+    ts: any;
+    checker: any;
+    /**
+     * where names in the documented type resolve (the
+     * prop's declaration, else the component's source file)
+     */
+    location: any;
+    /**
+     * the prop is optional, so `undefined` is set
+     * aside on both sides
+     */
+    optional: boolean;
+    /**
+     * whether a source
+     * file is one of TypeScript's own libraries
+     */
+    isDefaultLibrary?: ((file: any) => boolean) | undefined;
+    /**
+     * the project checks without strict null
+     * checks, so the compiler drops `null` and `undefined` from every type and
+     * both are set aside on both sides
+     */
+    nullable?: boolean | undefined;
+    /**
+     * the project sets
+     * `exactOptionalPropertyTypes`: an optional prop takes `undefined` only when
+     * its type says so, and the compiler's mark for an absent prop is not a
+     * type the prop takes
+     */
+    exactOptional?: boolean | undefined;
+    /**
+     * the code's type as the source writes it and
+     * as the compiler prints it, each a list of union members
+     */
+    written: string[][];
+};