MCPcopy Create free account
hub / github.com/Effect-TS/effect / documentation

Function documentation

packages/tools/api-diff/src/Snapshot.ts:546–561  ·  view source on GitHub ↗
(symbol: ts.Symbol, checker: ts.TypeChecker, module: string)

Source from the content-addressed store, hash-verified

544 [...new Set(declarations.map((declaration) => declaration.kind))].sort().join("+")
545
546const documentation = (symbol: ts.Symbol, checker: ts.TypeChecker, module: string): Documentation => {
547 const tags = new Map(
548 symbol.getJsDocTags(checker).map((tag) => [
549 tag.name,
550 tag.text?.map((part) => part.text).join("").trim() ?? ""
551 ])
552 )
553 const summary = ts.displayPartsToString(symbol.getDocumentationComment(checker)).trim()
554 return {
555 summary: summary === "" ? undefined : summary,
556 deprecated: tags.get("deprecated"),
557 since: tags.get("since"),
558 category: tags.get("category"),
559 stability: module.includes("/unstable/") ? "unstable" : "stable"
560 }
561}
562
563const bucketDeclarations = (symbol: ts.Symbol, bucket: Bucket): ReadonlyArray<ts.Declaration> => {
564 const declarations = symbol.declarations ?? []

Callers 1

extractSnapshotFunction · 0.85

Calls 3

joinMethod · 0.80
getMethod · 0.65
mapMethod · 0.45

Tested by

no test coverage detected