@apify/docusaurus-plugin-typedoc-api 5.1.10 → 5.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/lib/components/Comment.d.ts.map +1 -1
  2. package/lib/components/Comment.js +2 -2
  3. package/lib/components/Comment.js.map +1 -1
  4. package/lib/components/MemberDeclaration.d.ts.map +1 -1
  5. package/lib/components/MemberDeclaration.js +5 -3
  6. package/lib/components/MemberDeclaration.js.map +1 -1
  7. package/lib/components/MemberSignatureBody.d.ts.map +1 -1
  8. package/lib/components/MemberSignatureBody.js +8 -6
  9. package/lib/components/MemberSignatureBody.js.map +1 -1
  10. package/lib/components/styles.css +3 -1
  11. package/package.json +1 -1
  12. package/src/components/Comment.tsx +0 -8
  13. package/src/components/MemberDeclaration.tsx +9 -1
  14. package/src/components/MemberSignatureBody.tsx +13 -1
  15. package/src/components/styles.css +3 -1
package/lib/components/Comment.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Comment.d.ts","sourceRoot":"","sources":["../../src/components/Comment.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG1C,MAAM,WAAW,YAAY;IAC5B,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;IAC7B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,GAAG,OAAO,CAShE;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,UAAU,CAAC,kBAAkB,EAAE,GAAG,MAAM,CAUrF;AAED,wBAAgB,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAa,EAAE,EAAE,YAAY,2CAkDrE"}
1
+ {"version":3,"file":"Comment.d.ts","sourceRoot":"","sources":["../../src/components/Comment.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG1C,MAAM,WAAW,YAAY;IAC5B,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;IAC7B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,GAAG,OAAO,CAShE;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,UAAU,CAAC,kBAAkB,EAAE,GAAG,MAAM,CAUrF;AAED,wBAAgB,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAa,EAAE,EAAE,YAAY,2CA0CrE"}
package/lib/components/Comment.js CHANGED
@@ -21,7 +21,7 @@ export function displayPartsToMarkdown(parts) {
21
21
  .join('');
22
22
  }
23
23
  export function Comment({ comment, root, hideTags = [] }) {
24
- var _a, _b, _c, _d, _e;
24
+ var _a, _b;
25
25
  if (!comment || !hasComment(comment)) {
26
26
  return null;
27
27
  }
@@ -34,6 +34,6 @@ export function Comment({ comment, root, hideTags = [] }) {
34
34
  }
35
35
  return tag.tag !== '@default';
36
36
  })) !== null && _b !== void 0 ? _b : [];
37
- return (_jsxs("div", { className: `tsd-comment tsd-typography ${root ? 'tsd-comment-root' : ''}`, children: [!!comment.summary && (_jsx("div", { className: "lead", children: _jsx(Markdown, { content: displayPartsToMarkdown(comment.summary) }) })), blockTags.length > 0 && (_jsx("dl", { className: "tsd-comment-tags", children: blockTags.map((tag) => (_jsxs(Fragment, { children: [_jsx("dt", { children: _jsx("strong", { children: tag.tag }) }), _jsx("dd", { children: _jsx(Markdown, { content: displayPartsToMarkdown(tag.content) }) })] }, tag.tag))) })), ((_c = comment.blockTags) === null || _c === void 0 ? void 0 : _c.some((tag) => tag.tag === '@since')) && (_jsx("div", { className: "tsd-comment-since", children: _jsx(Markdown, { content: displayPartsToMarkdown((_e = (_d = comment.blockTags) === null || _d === void 0 ? void 0 : _d.find((tag) => tag.tag === '@since')) === null || _e === void 0 ? void 0 : _e.content) }) }))] }));
37
+ return (_jsxs("div", { className: `tsd-comment tsd-typography ${root ? 'tsd-comment-root' : ''}`, children: [!!comment.summary && (_jsx("div", { className: "lead", children: _jsx(Markdown, { content: displayPartsToMarkdown(comment.summary) }) })), blockTags.length > 0 && (_jsx("dl", { className: "tsd-comment-tags", children: blockTags.map((tag) => (_jsxs(Fragment, { children: [_jsx("dt", { children: _jsx("strong", { children: tag.tag }) }), _jsx("dd", { children: _jsx(Markdown, { content: displayPartsToMarkdown(tag.content) }) })] }, tag.tag))) }))] }));
38
38
  }
39
39
  //# sourceMappingURL=Comment.js.map
package/lib/components/Comment.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Comment.js","sourceRoot":"","sources":["../../src/components/Comment.tsx"],"names":[],"mappings":";AAAA,oGAAoG;AACpG,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAQtC,MAAM,UAAU,UAAU,CAAC,OAA4B;;IACtD,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACd,CAAC;IAED,OAAO,OAAO,CACb,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC;QAC/D,CAAC,OAAO,CAAC,SAAS,IAAI,CAAA,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,IAAG,CAAC,CAAC,CACrD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAsC;IAC5E,OAAO,KAAK;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YAChC,OAAO,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,CAAC,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,GAAG,EAAE,EAAgB;;IACrE,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,oBAAoB;IACpB,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5B,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAExB,MAAM,SAAS,GACd,MAAA,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;QACjC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,GAAG,CAAC,GAAG,KAAK,UAAU,CAAC;IAC/B,CAAC,CAAC,mCAAI,EAAE,CAAC;IAEV,OAAO,CACN,eAAK,SAAS,EAAE,8BAA8B,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,aAC5E,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,CACrB,cAAK,SAAS,EAAC,MAAM,YACpB,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,GAAI,GACzD,CACN,EAEA,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,CACxB,aAAI,SAAS,EAAC,kBAAkB,YAC9B,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CACvB,MAAC,QAAQ,eACR,uBACC,2BAAS,GAAG,CAAC,GAAG,GAAU,GACtB,EACL,uBACC,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,GAAI,GACtD,KANS,GAAG,CAAC,GAAG,CAOX,CACX,CAAC,GACE,CACL,EAGA,CAAA,MAAA,OAAO,CAAC,SAAS,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,KAAI,CACzD,cAAK,SAAS,EAAC,mBAAmB,YACjC,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,MAAA,MAAA,OAAO,CAAC,SAAS,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,0CAAE,OAAO,CAAC,GAAI,GACzG,CACN,IAEG,CACN,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"Comment.js","sourceRoot":"","sources":["../../src/components/Comment.tsx"],"names":[],"mappings":";AAAA,oGAAoG;AACpG,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAQtC,MAAM,UAAU,UAAU,CAAC,OAA4B;;IACtD,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACd,CAAC;IAED,OAAO,OAAO,CACb,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC;QAC/D,CAAC,OAAO,CAAC,SAAS,IAAI,CAAA,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,IAAG,CAAC,CAAC,CACrD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAsC;IAC5E,OAAO,KAAK;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YAChC,OAAO,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,CAAC,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,GAAG,EAAE,EAAgB;;IACrE,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,oBAAoB;IACpB,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5B,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAExB,MAAM,SAAS,GACd,MAAA,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;QACjC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,GAAG,CAAC,GAAG,KAAK,UAAU,CAAC;IAC/B,CAAC,CAAC,mCAAI,EAAE,CAAC;IAEV,OAAO,CACN,eAAK,SAAS,EAAE,8BAA8B,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,aAC5E,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,CACrB,cAAK,SAAS,EAAC,MAAM,YACpB,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,GAAI,GACzD,CACN,EAEA,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,CACxB,aAAI,SAAS,EAAC,kBAAkB,YAC9B,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CACvB,MAAC,QAAQ,eACR,uBACC,2BAAS,GAAG,CAAC,GAAG,GAAU,GACtB,EACL,uBACC,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,GAAI,GACtD,KANS,GAAG,CAAC,GAAG,CAOX,CACX,CAAC,GACE,CACL,IACI,CACN,CAAC;AACH,CAAC"}
package/lib/components/MemberDeclaration.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"MemberDeclaration.d.ts","sourceRoot":"","sources":["../../src/components/MemberDeclaration.tsx"],"names":[],"mappings":"AAcA,MAAM,WAAW,sBAAsB;IACtC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,sBAAsB,2CAgD/D"}
1
+ {"version":3,"file":"MemberDeclaration.d.ts","sourceRoot":"","sources":["../../src/components/MemberDeclaration.tsx"],"names":[],"mappings":"AAeA,MAAM,WAAW,sBAAsB;IACtC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,sBAAsB,2CAuD/D"}
package/lib/components/MemberDeclaration.js CHANGED
@@ -3,20 +3,22 @@ import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-run
3
3
  import { useMinimalLayout } from '../hooks/useMinimalLayout';
4
4
  import { useRequiredReflection } from '../hooks/useReflection';
5
5
  import { escapeMdx } from '../utils/helpers';
6
- import { Comment, hasComment } from './Comment';
6
+ import { Comment, displayPartsToMarkdown, hasComment } from './Comment';
7
7
  import { DefaultValue } from './DefaultValue';
8
8
  import { Icon } from './Icon';
9
+ import { Markdown } from './Markdown';
9
10
  import { MemberSources } from './MemberSources';
10
11
  import { Parameter } from './Parameter';
11
12
  import { extractDeclarationFromType, Type } from './Type';
12
13
  import { TypeParameters } from './TypeParameters';
13
14
  import { TypeParametersGeneric } from './TypeParametersGeneric';
14
15
  export function MemberDeclaration({ id }) {
15
- var _a;
16
+ var _a, _b, _c, _d, _e, _f;
16
17
  const reflection = useRequiredReflection(id);
17
18
  const minimal = useMinimalLayout();
18
19
  const showTypes = reflection.typeParameters && reflection.typeParameters.length > 0;
19
20
  const showDeclaration = !minimal && extractDeclarationFromType(reflection.type);
20
- return (_jsxs(_Fragment, { children: [_jsx("div", { className: "tsd-panel-content", children: _jsxs("div", { className: "tsd-signature tsd-kind-icon", children: [_jsx(Icon, { reflection: reflection }), escapeMdx(reflection.name), _jsx(TypeParametersGeneric, { params: reflection.typeParameters }), _jsxs("span", { className: "tsd-signature-symbol", children: [((_a = reflection.flags) === null || _a === void 0 ? void 0 : _a.isOptional) && '?', ": "] }), ' ', _jsx(Type, { type: reflection.type }), _jsx(DefaultValue, { comment: reflection.comment, type: reflection.type, value: reflection.defaultValue })] }) }), _jsxs("div", { className: "tsd-panel-content", children: [_jsx(MemberSources, { reflection: reflection }), _jsx(Comment, { comment: reflection.comment }), hasComment(reflection.comment) && (showTypes || showDeclaration) && (_jsx("hr", { className: "tsd-divider" })), showTypes && (_jsxs("div", { className: "tds-type-parameters", children: [_jsx("h4", { className: "tsd-type-parameters-title", children: "Type parameters" }), _jsx(TypeParameters, { params: reflection.typeParameters })] })), showDeclaration && (_jsxs("div", { className: "tsd-type-declaration", children: [_jsx("h4", { children: "Type declaration" }), _jsx(Parameter, { param: extractDeclarationFromType(reflection.type) })] }))] })] }));
21
+ const showSince = (_b = (_a = reflection.comment) === null || _a === void 0 ? void 0 : _a.blockTags) === null || _b === void 0 ? void 0 : _b.some((tag) => tag.tag === '@since');
22
+ return (_jsxs(_Fragment, { children: [_jsx("div", { className: "tsd-panel-content", children: _jsxs("div", { className: "tsd-signature tsd-kind-icon", children: [_jsx(Icon, { reflection: reflection }), escapeMdx(reflection.name), _jsx(TypeParametersGeneric, { params: reflection.typeParameters }), _jsxs("span", { className: "tsd-signature-symbol", children: [((_c = reflection.flags) === null || _c === void 0 ? void 0 : _c.isOptional) && '?', ": "] }), ' ', _jsx(Type, { type: reflection.type }), _jsx(DefaultValue, { comment: reflection.comment, type: reflection.type, value: reflection.defaultValue })] }) }), _jsxs("div", { className: "tsd-panel-content", children: [_jsx(MemberSources, { reflection: reflection }), _jsx(Comment, { comment: reflection.comment }), hasComment(reflection.comment) && (showTypes || showDeclaration) && (_jsx("hr", { className: "tsd-divider" })), showTypes && (_jsxs("div", { className: "tds-type-parameters", children: [_jsx("h4", { className: "tsd-type-parameters-title", children: "Type parameters" }), _jsx(TypeParameters, { params: reflection.typeParameters })] })), showDeclaration && (_jsxs("div", { className: "tsd-type-declaration", children: [_jsx("h4", { children: "Type declaration" }), _jsx(Parameter, { param: extractDeclarationFromType(reflection.type) })] })), showSince && (_jsx("div", { className: "tsd-comment-since", children: _jsx(Markdown, { content: displayPartsToMarkdown((_f = (_e = (_d = reflection.comment) === null || _d === void 0 ? void 0 : _d.blockTags) === null || _e === void 0 ? void 0 : _e.find((tag) => tag.tag === '@since')) === null || _f === void 0 ? void 0 : _f.content) }) }))] })] }));
21
23
  }
22
24
  //# sourceMappingURL=MemberDeclaration.js.map
package/lib/components/MemberDeclaration.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"MemberDeclaration.js","sourceRoot":"","sources":["../../src/components/MemberDeclaration.tsx"],"names":[],"mappings":";AAAA,+GAA+G;AAE/G,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,0BAA0B,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAMhE,MAAM,UAAU,iBAAiB,CAAC,EAAE,EAAE,EAA0B;;IAC/D,MAAM,UAAU,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,MAAM,SAAS,GAAG,UAAU,CAAC,cAAc,IAAI,UAAU,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;IACpF,MAAM,eAAe,GAAG,CAAC,OAAO,IAAI,0BAA0B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEhF,OAAO,CACN,8BACC,cAAK,SAAS,EAAC,mBAAmB,YACjC,eAAK,SAAS,EAAC,6BAA6B,aAC3C,KAAC,IAAI,IAAC,UAAU,EAAE,UAAU,GAAI,EAC/B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAC3B,KAAC,qBAAqB,IAAC,MAAM,EAAE,UAAU,CAAC,cAAc,GAAI,EAC5D,gBAAM,SAAS,EAAC,sBAAsB,aAAE,CAAA,MAAA,UAAU,CAAC,KAAK,0CAAE,UAAU,KAAI,GAAG,UAAU,EAAC,GAAG,EACzF,KAAC,IAAI,IAAC,IAAI,EAAE,UAAU,CAAC,IAAI,GAAI,EAC/B,KAAC,YAAY,IACZ,OAAO,EAAE,UAAU,CAAC,OAAO,EAC3B,IAAI,EAAE,UAAU,CAAC,IAAI,EACrB,KAAK,EAAE,UAAU,CAAC,YAAY,GAC7B,IACG,GACD,EAEN,eAAK,SAAS,EAAC,mBAAmB,aACjC,KAAC,aAAa,IAAC,UAAU,EAAE,UAAU,GAAI,EAEzC,KAAC,OAAO,IAAC,OAAO,EAAE,UAAU,CAAC,OAAO,GAAI,EAEvC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,eAAe,CAAC,IAAI,CACpE,aAAI,SAAS,EAAC,aAAa,GAAG,CAC9B,EAEA,SAAS,IAAI,CACb,eAAK,SAAS,EAAC,qBAAqB,aACnC,aAAI,SAAS,EAAC,2BAA2B,gCAAqB,EAC9D,KAAC,cAAc,IAAC,MAAM,EAAE,UAAU,CAAC,cAAc,GAAI,IAChD,CACN,EAEA,eAAe,IAAI,CACnB,eAAK,SAAS,EAAC,sBAAsB,aACpC,4CAAyB,EACzB,KAAC,SAAS,IAAC,KAAK,EAAE,0BAA0B,CAAC,UAAU,CAAC,IAAI,CAAC,GAAI,IAC5D,CACN,IACI,IACJ,CACH,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"MemberDeclaration.js","sourceRoot":"","sources":["../../src/components/MemberDeclaration.tsx"],"names":[],"mappings":";AAAA,+GAA+G;AAE/G,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,0BAA0B,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAMhE,MAAM,UAAU,iBAAiB,CAAC,EAAE,EAAE,EAA0B;;IAC/D,MAAM,UAAU,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,MAAM,SAAS,GAAG,UAAU,CAAC,cAAc,IAAI,UAAU,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;IACpF,MAAM,eAAe,GAAG,CAAC,OAAO,IAAI,0BAA0B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAChF,MAAM,SAAS,GAAG,MAAA,MAAA,UAAU,CAAC,OAAO,0CAAE,SAAS,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC;IAErF,OAAO,CACN,8BACC,cAAK,SAAS,EAAC,mBAAmB,YACjC,eAAK,SAAS,EAAC,6BAA6B,aAC3C,KAAC,IAAI,IAAC,UAAU,EAAE,UAAU,GAAI,EAC/B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAC3B,KAAC,qBAAqB,IAAC,MAAM,EAAE,UAAU,CAAC,cAAc,GAAI,EAC5D,gBAAM,SAAS,EAAC,sBAAsB,aAAE,CAAA,MAAA,UAAU,CAAC,KAAK,0CAAE,UAAU,KAAI,GAAG,UAAU,EAAC,GAAG,EACzF,KAAC,IAAI,IAAC,IAAI,EAAE,UAAU,CAAC,IAAI,GAAI,EAC/B,KAAC,YAAY,IACZ,OAAO,EAAE,UAAU,CAAC,OAAO,EAC3B,IAAI,EAAE,UAAU,CAAC,IAAI,EACrB,KAAK,EAAE,UAAU,CAAC,YAAY,GAC7B,IACG,GACD,EAEN,eAAK,SAAS,EAAC,mBAAmB,aACjC,KAAC,aAAa,IAAC,UAAU,EAAE,UAAU,GAAI,EAEzC,KAAC,OAAO,IAAC,OAAO,EAAE,UAAU,CAAC,OAAO,GAAI,EAEvC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,eAAe,CAAC,IAAI,CACpE,aAAI,SAAS,EAAC,aAAa,GAAG,CAC9B,EAEA,SAAS,IAAI,CACb,eAAK,SAAS,EAAC,qBAAqB,aACnC,aAAI,SAAS,EAAC,2BAA2B,gCAAqB,EAC9D,KAAC,cAAc,IAAC,MAAM,EAAE,UAAU,CAAC,cAAc,GAAI,IAChD,CACN,EAEA,eAAe,IAAI,CACnB,eAAK,SAAS,EAAC,sBAAsB,aACpC,4CAAyB,EACzB,KAAC,SAAS,IAAC,KAAK,EAAE,0BAA0B,CAAC,UAAU,CAAC,IAAI,CAAC,GAAI,IAC5D,CACN,EAEA,SAAS,IAAI,CACZ,cAAK,SAAS,EAAC,mBAAmB,YAClC,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,MAAA,MAAA,MAAA,UAAU,CAAC,OAAO,0CAAE,SAAS,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,0CAAE,OAAO,CAAC,GAAI,GACrH,CACN,IACI,IACJ,CACH,CAAC;AACH,CAAC"}
package/lib/components/MemberSignatureBody.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"MemberSignatureBody.d.ts","sourceRoot":"","sources":["../../src/components/MemberSignatureBody.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAU,MAAM,SAAS,CAAC;AAIlD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAWvD,wBAAgB,UAAU,CACzB,GAAG,EAAE,sBAAsB,GAAG,SAAS,EACvC,OAAO,EAAE,OAAO,EAChB,WAAW,GAAE,OAAe,miBAa5B;AAED,MAAM,WAAW,wBAAwB;IACxC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,GAAG,EAAE,sBAAsB,CAAC;CAC5B;AAoBD,wBAAgB,mBAAmB,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,wBAAwB,2CA+JjF"}
1
+ {"version":3,"file":"MemberSignatureBody.d.ts","sourceRoot":"","sources":["../../src/components/MemberSignatureBody.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAU,MAAM,SAAS,CAAC;AAIlD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAYvD,wBAAgB,UAAU,CACzB,GAAG,EAAE,sBAAsB,GAAG,SAAS,EACvC,OAAO,EAAE,OAAO,EAChB,WAAW,GAAE,OAAe,miBAa5B;AAED,MAAM,WAAW,wBAAwB;IACxC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,GAAG,EAAE,sBAAsB,CAAC;CAC5B;AAoBD,wBAAgB,mBAAmB,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,wBAAwB,2CA0KjF"}
package/lib/components/MemberSignatureBody.js CHANGED
@@ -4,7 +4,7 @@ import { Fragment, useContext } from 'react';
4
4
  import { usePluginData } from '@docusaurus/useGlobalData';
5
5
  import { useMinimalLayout } from '../hooks/useMinimalLayout';
6
6
  import { ApiDataContext } from './ApiDataContext';
7
- import { Comment, hasComment } from './Comment';
7
+ import { Comment, displayPartsToMarkdown, hasComment } from './Comment';
8
8
  import { CommentBadges, isCommentWithModifiers } from './CommentBadges';
9
9
  import { DefaultValue } from './DefaultValue';
10
10
  import { Flags } from './Flags';
@@ -12,6 +12,7 @@ import { hasSources, MemberSources } from './MemberSources';
12
12
  import { Parameter } from './Parameter';
13
13
  import { extractDeclarationFromType, Type } from './Type';
14
14
  import { TypeParameters } from './TypeParameters';
15
+ import { Markdown } from './Markdown';
15
16
  export function hasSigBody(sig, minimal, hideSources = false) {
16
17
  if (!sig) {
17
18
  return false;
@@ -36,15 +37,16 @@ function intoReturnComment(comment) {
36
37
  }
37
38
  const HIDE_TAGS = ['@returns', '@param'];
38
39
  export function MemberSignatureBody({ hideSources, sig }) {
39
- var _a, _b, _c;
40
+ var _a, _b, _c, _d, _e, _f, _g;
40
41
  const minimal = useMinimalLayout();
41
42
  const showTypes = sig.typeParameter && sig.typeParameter.length > 0;
42
43
  const showParams = !minimal && sig.parameters && sig.parameters.length > 0;
43
44
  const showReturn = !minimal && sig.type;
45
+ const showSince = (_b = (_a = sig.comment) === null || _a === void 0 ? void 0 : _a.blockTags) === null || _b === void 0 ? void 0 : _b.some((tag) => tag.tag === '@since');
44
46
  const { reflections } = useContext(ApiDataContext);
45
47
  const { isPython } = usePluginData('docusaurus-plugin-typedoc-api');
46
48
  if (isPython) {
47
- sig.parameters = (_a = sig.parameters) === null || _a === void 0 ? void 0 : _a.reduce((acc, param) => {
49
+ sig.parameters = (_c = sig.parameters) === null || _c === void 0 ? void 0 : _c.reduce((acc, param) => {
48
50
  var _a, _b, _c;
49
51
  // @ts-expect-error Silence ts errors
50
52
  switch ((_a = param.type) === null || _a === void 0 ? void 0 : _a.name) {
@@ -59,7 +61,7 @@ export function MemberSignatureBody({ hideSources, sig }) {
59
61
  }
60
62
  return acc;
61
63
  }, []);
62
- sig.parameters = (_b = sig.parameters) === null || _b === void 0 ? void 0 : _b.reduce((acc, param) => {
64
+ sig.parameters = (_d = sig.parameters) === null || _d === void 0 ? void 0 : _d.reduce((acc, param) => {
63
65
  var _a;
64
66
  // @ts-expect-error Silence ts errors
65
67
  switch ((_a = param.type) === null || _a === void 0 ? void 0 : _a.name) {
@@ -75,7 +77,7 @@ export function MemberSignatureBody({ hideSources, sig }) {
75
77
  return acc;
76
78
  }, []);
77
79
  }
78
- return (_jsxs(_Fragment, { children: [!hideSources && _jsx(MemberSources, { reflection: sig }), isCommentWithModifiers(sig.comment) && _jsx(CommentBadges, { comment: sig.comment }), _jsx(Comment, { comment: sig.comment, hideTags: HIDE_TAGS }), hasComment(sig.comment) && (showTypes || showParams || showReturn) && (_jsx("hr", { className: "tsd-divider" })), showTypes && (_jsxs(_Fragment, { children: [_jsx("h4", { className: "tsd-type-parameters-title", children: "Type parameters" }), _jsx(TypeParameters, { params: sig.typeParameter })] })), showParams && (_jsxs(_Fragment, { children: [_jsx("h4", { className: "tsd-parameters-title", children: "Parameters" }), _jsx("ul", { className: "tsd-parameters", children: (_c = sig.parameters) === null || _c === void 0 ? void 0 : _c.map((param) => {
80
+ return (_jsxs(_Fragment, { children: [!hideSources && _jsx(MemberSources, { reflection: sig }), isCommentWithModifiers(sig.comment) && _jsx(CommentBadges, { comment: sig.comment }), _jsx(Comment, { comment: sig.comment, hideTags: HIDE_TAGS }), hasComment(sig.comment) && (showTypes || showParams || showReturn) && (_jsx("hr", { className: "tsd-divider" })), showTypes && (_jsxs(_Fragment, { children: [_jsx("h4", { className: "tsd-type-parameters-title", children: "Type parameters" }), _jsx(TypeParameters, { params: sig.typeParameter })] })), showParams && (_jsxs(_Fragment, { children: [_jsx("h4", { className: "tsd-parameters-title", children: "Parameters" }), _jsx("ul", { className: "tsd-parameters", children: (_e = sig.parameters) === null || _e === void 0 ? void 0 : _e.map((param) => {
79
81
  var _a, _b, _c, _d, _e;
80
82
  return (_jsxs(Fragment, { children: [_jsxs("li", { children: [_jsxs("h5", { children: [_jsx(Flags, { flags: param.flags }), ((_a = param.flags) === null || _a === void 0 ? void 0 : _a.isRest) && _jsx("span", { className: "tsd-signature-symbol", children: "..." }), `${param.name}: `, _jsx(Type, { type: param.type }), _jsx(DefaultValue, { comment: param.comment, type: param.type, value: param.defaultValue })] }), _jsx(Comment, { comment: param.comment })] }), ((_b = param.type) === null || _b === void 0 ? void 0 : _b.type) === 'reflection' && (_jsx("ul", { children: (_d = (_c = param.type.declaration) === null || _c === void 0 ? void 0 : _c.children) === null || _d === void 0 ? void 0 : _d.map((reflectionChild) => {
81
83
  var _a;
@@ -88,6 +90,6 @@ export function MemberSignatureBody({ hideSources, sig }) {
88
90
  return (_jsxs("li", { children: [_jsxs("h5", { children: [_jsx(Flags, { flags: unionChild.flags }), ((_a = unionChild.flags) === null || _a === void 0 ? void 0 : _a.isRest) && (_jsx("span", { className: "tsd-signature-symbol", children: "..." })), `${unionChild.name}: `, _jsx(Type, { type: unionChild.type }), _jsx(DefaultValue, { comment: unionChild.comment, type: unionChild.type, value: unionChild.defaultValue })] }), _jsx(Comment, { comment: unionChild.comment })] }, unionChild.id));
89
91
  }) }, unionReflectionType.declaration.id));
90
92
  })] }, param.id));
91
- }) })] })), showReturn && (_jsxs(_Fragment, { children: [_jsxs("h4", { className: "tsd-returns-title", children: ["Returns ", _jsx(Type, { type: sig.type })] }), _jsx(Comment, { comment: intoReturnComment(sig.comment) }), _jsx(Parameter, { param: extractDeclarationFromType(sig.type) })] }))] }));
93
+ }) })] })), showReturn && (_jsxs(_Fragment, { children: [_jsxs("h4", { className: "tsd-returns-title", children: ["Returns ", _jsx(Type, { type: sig.type })] }), _jsx(Comment, { comment: intoReturnComment(sig.comment) }), _jsx(Parameter, { param: extractDeclarationFromType(sig.type) })] })), showSince && (_jsx(_Fragment, { children: _jsx("div", { className: "tsd-comment-since", children: _jsx(Markdown, { content: displayPartsToMarkdown((_g = (_f = sig.comment.blockTags) === null || _f === void 0 ? void 0 : _f.find((tag) => tag.tag === '@since')) === null || _g === void 0 ? void 0 : _g.content) }) }) }))] }));
92
94
  }
93
95
  //# sourceMappingURL=MemberSignatureBody.js.map
package/lib/components/MemberSignatureBody.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"MemberSignatureBody.js","sourceRoot":"","sources":["../../src/components/MemberSignatureBody.tsx"],"names":[],"mappings":";AAAA,kHAAkH;AAElH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAG7C,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,0BAA0B,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,UAAU,UAAU,CACzB,GAAuC,EACvC,OAAgB,EAChB,cAAuB,KAAK;IAE5B,IAAI,CAAC,GAAG,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACd,CAAC;IAED,OAAO,CACN,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;QACjC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC;QACvB,CAAC,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;QACnD,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;QACzD,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CACtB,CAAC;AACH,CAAC;AAOD,SAAS,iBAAiB,CAAC,OAA4B;IACtD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAErD,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAEvC,OAAO;gBACN,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO;aACzC,CAAC;QACH,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAEzC,MAAM,UAAU,mBAAmB,CAAC,EAAE,WAAW,EAAE,GAAG,EAA4B;;IACjF,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;IACpE,MAAM,UAAU,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC;IAExC,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IACnD,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC,+BAA+B,CAAe,CAAC;IAElF,IAAI,QAAQ,EAAE,CAAC;QACd,GAAG,CAAC,UAAU,GAAG,MAAA,GAAG,CAAC,UAAU,0CAAE,MAAM,CAAwB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;;YAC7E,qCAAqC;YACrC,QAAQ,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,EAAE,CAAC;gBAC1B,KAAK,QAAQ;oBACZ,qCAAqC;oBACrC,sEAAsE;oBACtE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAA,MAAA,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,0CAAE,QAAQ,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAK,CAAC,KAAE,KAAK,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAG,CAAC,CACnJ,CAAC;oBACF,MAAM;gBACP;oBACC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAChB,MAAM;YACR,CAAC;YAED,OAAO,GAAG,CAAC;QACZ,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,GAAG,CAAC,UAAU,GAAG,MAAA,GAAG,CAAC,UAAU,0CAAE,MAAM,CAAwB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;;YAC7E,qCAAqC;YACrC,QAAQ,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,EAAE,CAAC;gBAC1B,KAAK,aAAa;oBACjB,qCAAqC;oBACrC,2BAA2B;oBAC3B,GAAG,CAAC,IAAI,iCAAM,KAAK,KAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAG,CAAC;oBAC1D,MAAM;gBACP;oBACC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAChB,MAAM;YACR,CAAC;YAED,OAAO,GAAG,CAAC;QACZ,CAAC,EAAE,EAAE,CAAC,CAAC;IACR,CAAC;IAED,OAAO,CACN,8BACE,CAAC,WAAW,IAAI,KAAC,aAAa,IAAC,UAAU,EAAE,GAAG,GAAI,EAElD,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAC,aAAa,IAAC,OAAO,EAAE,GAAG,CAAC,OAAO,GAAI,EAE/E,KAAC,OAAO,IAAC,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,GAAI,EAErD,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,UAAU,IAAI,UAAU,CAAC,IAAI,CACtE,aAAI,SAAS,EAAC,aAAa,GAAG,CAC9B,EAEA,SAAS,IAAI,CACb,8BACC,aAAI,SAAS,EAAC,2BAA2B,gCAAqB,EAC9D,KAAC,cAAc,IAAC,MAAM,EAAE,GAAG,CAAC,aAAa,GAAI,IAC3C,CACH,EAEA,UAAU,IAAI,CACd,8BACC,aAAI,SAAS,EAAC,sBAAsB,2BAAgB,EAEpD,aAAI,SAAS,EAAC,gBAAgB,YAC5B,MAAA,GAAG,CAAC,UAAU,0CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;4BAAC,OAAA,CAC/B,MAAC,QAAQ,eACR,yBACC,yBACC,KAAC,KAAK,IAAC,KAAK,EAAE,KAAK,CAAC,KAAK,GAAI,EAC5B,CAAA,MAAA,KAAK,CAAC,KAAK,0CAAE,MAAM,KAAI,eAAM,SAAS,EAAC,sBAAsB,oBAAW,EACxE,GAAG,KAAK,CAAC,IAAI,IAAI,EAClB,KAAC,IAAI,IAAC,IAAI,EAAE,KAAK,CAAC,IAAI,GAAI,EAC1B,KAAC,YAAY,IACZ,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,KAAK,EAAE,KAAK,CAAC,YAAY,GACxB,IACE,EAEL,KAAC,OAAO,IAAC,OAAO,EAAE,KAAK,CAAC,OAAO,GAAI,IAC/B,EAEJ,CAAA,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,MAAK,YAAY,IAAI,CACrC,uBACE,MAAA,MAAA,KAAK,CAAC,IAAI,CAAC,WAAW,0CAAE,QAAQ,0CAAE,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE;;4CAAC,OAAA,CAC3D,yBACC,yBACC,KAAC,KAAK,IAAC,KAAK,EAAE,eAAe,CAAC,KAAK,GAAI,EACtC,CAAA,MAAA,eAAe,CAAC,KAAK,0CAAE,MAAM,KAAI,CACjC,eAAM,SAAS,EAAC,sBAAsB,oBAAW,CACjD,EACA,GAAG,eAAe,CAAC,IAAI,IAAI,EAC5B,KAAC,IAAI,IAAC,IAAI,EAAE,eAAe,CAAC,IAAI,GAAI,EACpC,KAAC,YAAY,IACZ,OAAO,EAAE,eAAe,CAAC,OAAwC,EACjE,IAAI,EAAE,eAAe,CAAC,IAAI,EAC1B,KAAK,EAAE,eAAe,CAAC,YAAY,GAClC,IACE,EAEL,KAAC,OAAO,IACP,OAAO,EAAE,eAAe,CAAC,OAAwC,GAChE,KAjBM,eAAe,CAAC,EAAE,CAkBtB,CACL,CAAA;yCAAA,CAAC,IArBM,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAsB7B,CACL,EAEA,CAAA,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,MAAK,OAAO;wCAE3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CACtB,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,YAAY,CAE/C,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,EAAE;;4CAAC,OAAA,CAC9B,uBACE,MAAA,MAAA,mBAAmB,CAAC,WAAW,0CAAE,QAAQ,0CAAE,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;;oDAAC,OAAA,CAC/D,yBACC,yBACC,KAAC,KAAK,IAAC,KAAK,EAAE,UAAU,CAAC,KAAK,GAAI,EACjC,CAAA,MAAA,UAAU,CAAC,KAAK,0CAAE,MAAM,KAAI,CAC5B,eAAM,SAAS,EAAC,sBAAsB,oBAAW,CACjD,EACA,GAAG,UAAU,CAAC,IAAI,IAAI,EACvB,KAAC,IAAI,IAAC,IAAI,EAAE,UAAU,CAAC,IAAI,GAAI,EAC/B,KAAC,YAAY,IACZ,OAAO,EAAE,UAAU,CAAC,OAAwC,EAC5D,IAAI,EAAE,UAAU,CAAC,IAAI,EACrB,KAAK,EAAE,UAAU,CAAC,YAAY,GAC7B,IACE,EAEL,KAAC,OAAO,IAAC,OAAO,EAAE,UAAU,CAAC,OAAwC,GAAI,KAfjE,UAAU,CAAC,EAAE,CAgBjB,CACL,CAAA;iDAAA,CAAC,IAnBM,mBAAmB,CAAC,WAAW,CAAC,EAAE,CAoBtC,CACL,CAAA;yCAAA,CAAC,KAtEW,KAAK,CAAC,EAAE,CAuEZ,CACX,CAAA;yBAAA,CAAC,GACE,IACH,CACH,EAEA,UAAU,IAAI,CACd,8BACC,cAAI,SAAS,EAAC,mBAAmB,yBACxB,KAAC,IAAI,IAAC,IAAI,EAAE,GAAG,CAAC,IAAI,GAAI,IAC5B,EAEL,KAAC,OAAO,IAAC,OAAO,EAAE,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,GAAI,EAEpD,KAAC,SAAS,IAAC,KAAK,EAAE,0BAA0B,CAAC,GAAG,CAAC,IAAI,CAAC,GAAI,IACxD,CACH,IACC,CACH,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"MemberSignatureBody.js","sourceRoot":"","sources":["../../src/components/MemberSignatureBody.tsx"],"names":[],"mappings":";AAAA,kHAAkH;AAElH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAG7C,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,0BAA0B,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,UAAU,UAAU,CACzB,GAAuC,EACvC,OAAgB,EAChB,cAAuB,KAAK;IAE5B,IAAI,CAAC,GAAG,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACd,CAAC;IAED,OAAO,CACN,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;QACjC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC;QACvB,CAAC,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;QACnD,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;QACzD,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CACtB,CAAC;AACH,CAAC;AAOD,SAAS,iBAAiB,CAAC,OAA4B;IACtD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAErD,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAEvC,OAAO;gBACN,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO;aACzC,CAAC;QACH,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAEzC,MAAM,UAAU,mBAAmB,CAAC,EAAE,WAAW,EAAE,GAAG,EAA4B;;IACjF,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;IACpE,MAAM,UAAU,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC;IACxC,MAAM,SAAS,GAAG,MAAA,MAAA,GAAG,CAAC,OAAO,0CAAE,SAAS,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC;IAE9E,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IACnD,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC,+BAA+B,CAAe,CAAC;IAElF,IAAI,QAAQ,EAAE,CAAC;QACd,GAAG,CAAC,UAAU,GAAG,MAAA,GAAG,CAAC,UAAU,0CAAE,MAAM,CAAwB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;;YAC7E,qCAAqC;YACrC,QAAQ,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,EAAE,CAAC;gBAC1B,KAAK,QAAQ;oBACZ,qCAAqC;oBACrC,sEAAsE;oBACtE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAA,MAAA,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,0CAAE,QAAQ,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAK,CAAC,KAAE,KAAK,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAG,CAAC,CACnJ,CAAC;oBACF,MAAM;gBACP;oBACC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAChB,MAAM;YACR,CAAC;YAED,OAAO,GAAG,CAAC;QACZ,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,GAAG,CAAC,UAAU,GAAG,MAAA,GAAG,CAAC,UAAU,0CAAE,MAAM,CAAwB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;;YAC7E,qCAAqC;YACrC,QAAQ,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,EAAE,CAAC;gBAC1B,KAAK,aAAa;oBACjB,qCAAqC;oBACrC,2BAA2B;oBAC3B,GAAG,CAAC,IAAI,iCAAM,KAAK,KAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAG,CAAC;oBAC1D,MAAM;gBACP;oBACC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAChB,MAAM;YACR,CAAC;YAED,OAAO,GAAG,CAAC;QACZ,CAAC,EAAE,EAAE,CAAC,CAAC;IACR,CAAC;IAED,OAAO,CACN,8BACE,CAAC,WAAW,IAAI,KAAC,aAAa,IAAC,UAAU,EAAE,GAAG,GAAI,EAElD,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAC,aAAa,IAAC,OAAO,EAAE,GAAG,CAAC,OAAO,GAAI,EAE/E,KAAC,OAAO,IAAC,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,GAAI,EAErD,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,UAAU,IAAI,UAAU,CAAC,IAAI,CACtE,aAAI,SAAS,EAAC,aAAa,GAAG,CAC9B,EAEA,SAAS,IAAI,CACb,8BACC,aAAI,SAAS,EAAC,2BAA2B,gCAAqB,EAC9D,KAAC,cAAc,IAAC,MAAM,EAAE,GAAG,CAAC,aAAa,GAAI,IAC3C,CACH,EAEA,UAAU,IAAI,CACd,8BACC,aAAI,SAAS,EAAC,sBAAsB,2BAAgB,EAEpD,aAAI,SAAS,EAAC,gBAAgB,YAC5B,MAAA,GAAG,CAAC,UAAU,0CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;4BAAC,OAAA,CAC/B,MAAC,QAAQ,eACR,yBACC,yBACC,KAAC,KAAK,IAAC,KAAK,EAAE,KAAK,CAAC,KAAK,GAAI,EAC5B,CAAA,MAAA,KAAK,CAAC,KAAK,0CAAE,MAAM,KAAI,eAAM,SAAS,EAAC,sBAAsB,oBAAW,EACxE,GAAG,KAAK,CAAC,IAAI,IAAI,EAClB,KAAC,IAAI,IAAC,IAAI,EAAE,KAAK,CAAC,IAAI,GAAI,EAC1B,KAAC,YAAY,IACZ,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,KAAK,EAAE,KAAK,CAAC,YAAY,GACxB,IACE,EAEL,KAAC,OAAO,IAAC,OAAO,EAAE,KAAK,CAAC,OAAO,GAAI,IAC/B,EAEJ,CAAA,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,MAAK,YAAY,IAAI,CACrC,uBACE,MAAA,MAAA,KAAK,CAAC,IAAI,CAAC,WAAW,0CAAE,QAAQ,0CAAE,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE;;4CAAC,OAAA,CAC3D,yBACC,yBACC,KAAC,KAAK,IAAC,KAAK,EAAE,eAAe,CAAC,KAAK,GAAI,EACtC,CAAA,MAAA,eAAe,CAAC,KAAK,0CAAE,MAAM,KAAI,CACjC,eAAM,SAAS,EAAC,sBAAsB,oBAAW,CACjD,EACA,GAAG,eAAe,CAAC,IAAI,IAAI,EAC5B,KAAC,IAAI,IAAC,IAAI,EAAE,eAAe,CAAC,IAAI,GAAI,EACpC,KAAC,YAAY,IACZ,OAAO,EAAE,eAAe,CAAC,OAAwC,EACjE,IAAI,EAAE,eAAe,CAAC,IAAI,EAC1B,KAAK,EAAE,eAAe,CAAC,YAAY,GAClC,IACE,EAEL,KAAC,OAAO,IACP,OAAO,EAAE,eAAe,CAAC,OAAwC,GAChE,KAjBM,eAAe,CAAC,EAAE,CAkBtB,CACL,CAAA;yCAAA,CAAC,IArBM,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAsB7B,CACL,EAEA,CAAA,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,MAAK,OAAO;wCAE3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CACtB,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,YAAY,CAE/C,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,EAAE;;4CAAC,OAAA,CAC9B,uBACE,MAAA,MAAA,mBAAmB,CAAC,WAAW,0CAAE,QAAQ,0CAAE,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;;oDAAC,OAAA,CAC/D,yBACC,yBACC,KAAC,KAAK,IAAC,KAAK,EAAE,UAAU,CAAC,KAAK,GAAI,EACjC,CAAA,MAAA,UAAU,CAAC,KAAK,0CAAE,MAAM,KAAI,CAC5B,eAAM,SAAS,EAAC,sBAAsB,oBAAW,CACjD,EACA,GAAG,UAAU,CAAC,IAAI,IAAI,EACvB,KAAC,IAAI,IAAC,IAAI,EAAE,UAAU,CAAC,IAAI,GAAI,EAC/B,KAAC,YAAY,IACZ,OAAO,EAAE,UAAU,CAAC,OAAwC,EAC5D,IAAI,EAAE,UAAU,CAAC,IAAI,EACrB,KAAK,EAAE,UAAU,CAAC,YAAY,GAC7B,IACE,EAEL,KAAC,OAAO,IAAC,OAAO,EAAE,UAAU,CAAC,OAAwC,GAAI,KAfjE,UAAU,CAAC,EAAE,CAgBjB,CACL,CAAA;iDAAA,CAAC,IAnBM,mBAAmB,CAAC,WAAW,CAAC,EAAE,CAoBtC,CACL,CAAA;yCAAA,CAAC,KAtEW,KAAK,CAAC,EAAE,CAuEZ,CACX,CAAA;yBAAA,CAAC,GACE,IACH,CACH,EAEA,UAAU,IAAI,CACd,8BACC,cAAI,SAAS,EAAC,mBAAmB,yBACxB,KAAC,IAAI,IAAC,IAAI,EAAE,GAAG,CAAC,IAAI,GAAI,IAC5B,EAEL,KAAC,OAAO,IAAC,OAAO,EAAE,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,GAAI,EAEpD,KAAC,SAAS,IAAC,KAAK,EAAE,0BAA0B,CAAC,GAAG,CAAC,IAAI,CAAC,GAAI,IACxD,CACH,EAGA,SAAS,IAAI,CACZ,4BACC,cAAK,SAAS,EAAC,mBAAmB,YACjC,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,MAAA,MAAA,GAAG,CAAC,OAAO,CAAC,SAAS,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,0CAAE,OAAO,CAAC,GAAI,GAC7G,GACJ,CACH,IAEA,CACH,CAAC;AACH,CAAC"}
package/lib/components/styles.css CHANGED
@@ -194,7 +194,9 @@ html[data-theme='light'] .tsd-panel-content {
194
194
  .tsd-comment-since {
195
195
  font-style: italic;
196
196
  font-size: 90%;
197
- margin-top: 1em;
197
+ margin-top: 0.5em;
198
+ padding-top: 0.5em;
199
+ border-top: 1px solid rgba(0, 0, 0, 0.05);
198
200
  }
199
201
 
200
202
  .tsd-comment-root {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@apify/docusaurus-plugin-typedoc-api",
3
- "version": "5.1.10",
3
+ "version": "5.1.11",
4
4
  "description": "Docusaurus plugin that provides source code API documentation powered by TypeDoc.",
5
5
  "workspaces": [
6
6
  "playground/website"
package/src/components/Comment.tsx CHANGED
@@ -72,14 +72,6 @@ export function Comment({ comment, root, hideTags = [] }: CommentProps) {
72
72
  ))}
73
73
  </dl>
74
74
  )}
75
-
76
- {
77
- comment.blockTags?.some((tag) => tag.tag === '@since') && (
78
- <div className="tsd-comment-since">
79
- <Markdown content={displayPartsToMarkdown(comment.blockTags?.find((tag) => tag.tag === '@since')?.content)} />
80
- </div>
81
- )
82
- }
83
75
  </div>
84
76
  );
85
77
  }
package/src/components/MemberDeclaration.tsx CHANGED
@@ -3,9 +3,10 @@
3
3
  import { useMinimalLayout } from '../hooks/useMinimalLayout';
4
4
  import { useRequiredReflection } from '../hooks/useReflection';
5
5
  import { escapeMdx } from '../utils/helpers';
6
- import { Comment, hasComment } from './Comment';
6
+ import { Comment, displayPartsToMarkdown, hasComment } from './Comment';
7
7
  import { DefaultValue } from './DefaultValue';
8
8
  import { Icon } from './Icon';
9
+ import { Markdown } from './Markdown';
9
10
  import { MemberSources } from './MemberSources';
10
11
  import { Parameter } from './Parameter';
11
12
  import { extractDeclarationFromType, Type } from './Type';
@@ -21,6 +22,7 @@ export function MemberDeclaration({ id }: MemberDeclarationProps) {
21
22
  const minimal = useMinimalLayout();
22
23
  const showTypes = reflection.typeParameters && reflection.typeParameters.length > 0;
23
24
  const showDeclaration = !minimal && extractDeclarationFromType(reflection.type);
25
+ const showSince = reflection.comment?.blockTags?.some((tag) => tag.tag === '@since');
24
26
 
25
27
  return (
26
28
  <>
@@ -61,6 +63,12 @@ export function MemberDeclaration({ id }: MemberDeclarationProps) {
61
63
  <Parameter param={extractDeclarationFromType(reflection.type)} />
62
64
  </div>
63
65
  )}
66
+
67
+ {showSince && (
68
+ <div className="tsd-comment-since">
69
+ <Markdown content={displayPartsToMarkdown(reflection.comment?.blockTags?.find((tag) => tag.tag === '@since')?.content)} />
70
+ </div>
71
+ )}
64
72
  </div>
65
73
  </>
66
74
  );
package/src/components/MemberSignatureBody.tsx CHANGED
@@ -7,7 +7,7 @@ import { usePluginData } from '@docusaurus/useGlobalData';
7
7
  import { useMinimalLayout } from '../hooks/useMinimalLayout';
8
8
  import type { TSDSignatureReflection } from '../types';
9
9
  import { ApiDataContext } from './ApiDataContext';
10
- import { Comment, hasComment } from './Comment';
10
+ import { Comment, displayPartsToMarkdown, hasComment } from './Comment';
11
11
  import { CommentBadges, isCommentWithModifiers } from './CommentBadges';
12
12
  import { DefaultValue } from './DefaultValue';
13
13
  import { Flags } from './Flags';
@@ -15,6 +15,7 @@ import { hasSources, MemberSources } from './MemberSources';
15
15
  import { Parameter } from './Parameter';
16
16
  import { extractDeclarationFromType, Type } from './Type';
17
17
  import { TypeParameters } from './TypeParameters';
18
+ import { Markdown } from './Markdown';
18
19
 
19
20
  export function hasSigBody(
20
21
  sig: TSDSignatureReflection | undefined,
@@ -62,6 +63,7 @@ export function MemberSignatureBody({ hideSources, sig }: MemberSignatureBodyPro
62
63
  const showTypes = sig.typeParameter && sig.typeParameter.length > 0;
63
64
  const showParams = !minimal && sig.parameters && sig.parameters.length > 0;
64
65
  const showReturn = !minimal && sig.type;
66
+ const showSince = sig.comment?.blockTags?.some((tag) => tag.tag === '@since');
65
67
 
66
68
  const { reflections } = useContext(ApiDataContext);
67
69
  const { isPython } = usePluginData('docusaurus-plugin-typedoc-api') as GlobalData;
@@ -214,6 +216,16 @@ export function MemberSignatureBody({ hideSources, sig }: MemberSignatureBodyPro
214
216
  <Parameter param={extractDeclarationFromType(sig.type)} />
215
217
  </>
216
218
  )}
219
+
220
+ {
221
+ showSince && (
222
+ <>
223
+ <div className="tsd-comment-since">
224
+ <Markdown content={displayPartsToMarkdown(sig.comment.blockTags?.find((tag) => tag.tag === '@since')?.content)} />
225
+ </div>
226
+ </>
227
+ )
228
+ }
217
229
  </>
218
230
  );
219
231
  }
package/src/components/styles.css CHANGED
@@ -194,7 +194,9 @@ html[data-theme='light'] .tsd-panel-content {
194
194
  .tsd-comment-since {
195
195
  font-style: italic;
196
196
  font-size: 90%;
197
- margin-top: 1em;
197
+ margin-top: 0.5em;
198
+ padding-top: 0.5em;
199
+ border-top: 1px solid rgba(0, 0, 0, 0.05);
198
200
  }
199
201
 
200
202
  .tsd-comment-root {