MCPcopy Create free account
hub / github.com/TanStack/query / resolveInterfacePages

Function resolveInterfacePages

scripts/generate-docs.ts:629–666  ·  view source on GitHub ↗
(
  outputDir: string,
  from: string,
)

Source from the content-addressed store, hash-verified

627// table, or the members of a plain alias or union. Anything else (intersections, `Omit`, `Override`, …)
628// resolves to nothing, since no generated table describes it as-is.
629async function resolveInterfacePages(
630 outputDir: string,
631 from: string,
632): Promise<Array<string> | undefined> {
633 const source = await readPage(outputDir, from)
634 if (source === undefined) {
635 return undefined
636 }
637 if (source.includes('\n## Properties\n')) {
638 return [from]
639 }
640 const code = typeAliasBody(source)
641 if (!code) {
642 return undefined
643 }
644 let members = code
645 while (/<[^<>]*>/.test(members)) {
646 members = members.replace(/<[^<>]*>/g, '')
647 }
648 const names = members
649 .split('|')
650 .map((member) => member.trim())
651 .filter(Boolean)
652 if (!names.every((name) => /^\w+$/.test(name))) {
653 return undefined
654 }
655 const pages: Array<string> = []
656 for (const name of names) {
657 const resolved =
658 (await resolveInterfacePages(outputDir, `interfaces/${name}`)) ??
659 (await resolveInterfacePages(outputDir, `type-aliases/${name}`))
660 if (!resolved) {
661 return undefined
662 }
663 pages.push(...resolved)
664 }
665 return pages
666}
667
668// The page whose `## Properties` table describes the type: the type itself, or the interface every
669// member of a union extends.

Callers 1

propertiesPageFunction · 0.85

Calls 2

readPageFunction · 0.85
typeAliasBodyFunction · 0.85

Tested by

no test coverage detected