Function getClassLikeDocsFromType

tools/dgeni/common/class-inheritance.ts:61–109

* Gets all class-like Dgeni documents from the given type. e.g. intersection types of * multiple classes will result in multiple Dgeni API documents for each class.

(
  type: ts.Type,
  baseDoc: ClassLikeExportDoc,
  exportSymbolsToDocsMap: Map<ts.Symbol, ClassLikeExportDoc>,
)

 * multiple classes will result in multiple Dgeni API documents for each class.
 */
function getClassLikeDocsFromType(
  type: ts.Type,
  baseDoc: ClassLikeExportDoc,
  exportSymbolsToDocsMap: Map<ts.Symbol, ClassLikeExportDoc>,
): ClassLikeExportDoc[] {
  let aliasSymbol: ts.Symbol | undefined = undefined;
  let symbol: ts.Symbol = type.symbol;
  const typeChecker = baseDoc.typeChecker;

  // Symbols can be aliases of the declaration symbol. e.g. in named import
  // specifiers. We need to resolve the aliased symbol back to the declaration symbol.
  if (symbol && (symbol.flags & ts.SymbolFlags.Alias) !== 0) {
    aliasSymbol = symbol;
    symbol = typeChecker.getAliasedSymbol(symbol);
  }

  // Intersection types are commonly used in TypeScript mixins to express the
  // class augmentation. e.g. "BaseClass & CanColor".
  if (type.isIntersection()) {
    return type.types.reduce(
      (res, t) => [...res, ...getClassLikeDocsFromType(t, baseDoc, exportSymbolsToDocsMap)],
      [] as ClassLikeExportDoc[],
    );
  } else if (symbol) {
    // If the given symbol has already been registered within Dgeni, we use the
    // existing symbol instead of creating a new one. The dgeni typescript package
    // keeps track of all exported symbols and their corresponding docs. See:
    // dgeni-packages/blob/master/typescript/src/processors/linkInheritedDocs.ts
    if (exportSymbolsToDocsMap.has(symbol)) {
      return [exportSymbolsToDocsMap.get(symbol)!];
    }
    let createdDoc: InheritanceCreatedClassLikeDoc | null = null;
    if ((symbol.flags & ts.SymbolFlags.Class) !== 0) {
      createdDoc = new ClassExportDoc(baseDoc.host, baseDoc.moduleDoc, symbol, aliasSymbol);
    } else if ((symbol.flags & ts.SymbolFlags.Interface) !== 0) {
      createdDoc = new InterfaceExportDoc(baseDoc.host, baseDoc.moduleDoc, symbol, aliasSymbol);
    }

    if (createdDoc) {
      // Mark the created document. This allows us to distinguish between documents which
      // have been resolved by Dgeni automatically, and docs which are manually resolved.
      createdDoc._inheritanceCreated = true;
      // If a new document has been created, add it to the shared symbol.
      exportSymbolsToDocsMap.set(aliasSymbol || symbol, createdDoc);
      return [createdDoc];
    }
  }
  return [];
}