Spaces:
Sleeping
Sleeping
File size: 23,581 Bytes
31248b9 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 | {
"name": "@microsoft/tsdoc",
"entries": [
{
"version": "0.16.0",
"tag": "@microsoft/tsdoc_v0.16.0",
"date": "Tue, 11 Nov 2025 00:51:42 GMT",
"comments": {
"minor": [
{
"comment": "Normalize builtin imports."
},
{
"comment": "Standardize TypeScript's `@jsx`, `@jsxRuntime`, `@jsxFrag`, `@jsxImportSource` tags."
}
],
"patch": [
{
"comment": "Ensure TSDocEmitter does not emit a newline for the text after `@defaultValue` tags."
},
{
"comment": "Remove test files and declaration maps from the published package."
}
]
}
},
{
"version": "0.15.1",
"tag": "@microsoft/tsdoc_v0.15.1",
"date": "Sat, 23 Nov 2024 00:23:35 GMT",
"comments": {
"patch": [
{
"comment": "Include CHANGELOG.md in published releases again"
}
]
}
},
{
"version": "0.15.0",
"tag": "@microsoft/tsdoc_v0.15.0",
"date": "Tue, 28 May 2024 21:34:19 GMT",
"comments": {
"minor": [
{
"comment": "Minor package cleanup."
},
{
"comment": "Eliminate remaining const enums."
}
],
"patch": [
{
"comment": "Update an image URL in the README.md file"
},
{
"comment": "Upgrade dev toolchain (Heft, Webpack, TypeScript)"
}
]
}
},
{
"version": "0.14.2",
"tag": "@microsoft/tsdoc_v0.14.2",
"date": "Wed, 14 Sep 2022 02:55:06 GMT",
"comments": {
"patch": [
{
"comment": "Update an internal type import to avoid a circular reference (GitHub #327 and #328)"
}
]
}
},
{
"version": "0.14.1",
"tag": "@microsoft/tsdoc_v0.14.1",
"date": "Sat, 09 Apr 2022 02:28:41 GMT",
"comments": {
"patch": [
{
"comment": "Rename the \"master\" branch to \"main.\""
}
]
}
},
{
"version": "0.14.0",
"tag": "@microsoft/tsdoc_v0.14.0",
"date": "Thu, 07 Apr 2022 22:51:07 GMT",
"comments": {
"minor": [
{
"comment": "Add `supportedHtmlElements` and `reportUnsupportedHtmlElements` options and corresponding validation"
},
{
"comment": "Convert \"const enum\" APIs to be regular enums to enable compatibility with isolatedModules=true (GitHub #306)"
}
]
}
},
{
"version": "0.13.2",
"tag": "@microsoft/tsdoc_v0.13.2",
"date": "Tue, 20 Apr 2021 04:25:13 GMT",
"comments": {
"patch": [
{
"comment": "Fix an issue where \"tsdoc-inline-tag-missing-braces\" and \"tsdoc-tag-should-not-have-braces\" were reported incorrectly"
}
]
}
},
{
"version": "0.13.1",
"tag": "@microsoft/tsdoc_v0.13.1",
"date": "Mon, 19 Apr 2021 21:22:32 GMT",
"comments": {
"patch": [
{
"comment": "Add a new TSDocMessageId definition used by @microsoft/tsdoc-config"
}
]
}
},
{
"version": "0.13.0",
"tag": "@microsoft/tsdoc_v0.13.0",
"date": "Fri, 22 Jan 2021 18:07:19 GMT",
"comments": {
"patch": [
{
"comment": "Update doc comments to fix some syntax issues"
}
],
"minor": [
{
"comment": "Update tsdoc.json schema to add a new field \"noStandardTags\""
},
{
"comment": "Add new APIs: TSDocConfiguration.clear() and TSDocTagDefinition.validateTSDocTagName()"
},
{
"comment": "Add new \"supportForTags\" field to tsdoc.json schema"
}
]
}
},
{
"version": "0.12.24",
"tag": "@microsoft/tsdoc_v0.12.24",
"date": "Thu, 03 Dec 2020 08:07:55 GMT",
"comments": {
"patch": [
{
"comment": "Add a missing declaration file"
}
]
}
},
{
"version": "0.12.23",
"tag": "@microsoft/tsdoc_v0.12.23",
"date": "Thu, 03 Dec 2020 04:31:52 GMT",
"comments": {
"patch": [
{
"comment": "Add a definition for the `@decorator` block tag (RFC 271)"
}
]
}
},
{
"version": "0.12.22",
"tag": "@microsoft/tsdoc_v0.12.22",
"date": "Mon, 30 Nov 2020 06:16:21 GMT",
"comments": {
"patch": [
{
"comment": "Update documentation to reference the new website URL"
},
{
"comment": "Upgrade build tools and configuration"
},
{
"comment": "Fix typo"
}
]
}
},
{
"version": "0.12.21",
"tag": "@microsoft/tsdoc_v0.12.21",
"date": "Fri, 04 Sep 2020 15:53:27 GMT",
"comments": {
"patch": [
{
"comment": "Fix an issue where the line extractor's trailing whitespace trimming sometimes trimmed a non-whitespace character (GitHub #258)"
},
{
"comment": "Update build system"
}
]
}
},
{
"version": "0.12.20",
"tag": "@microsoft/tsdoc_v0.12.20",
"date": "Wed, 20 May 2020 22:33:27 GMT",
"comments": {
"patch": [
{
"comment": "Add support for `@see` tag"
},
{
"comment": "Improve documentation for `@inheritDoc`"
}
]
}
},
{
"version": "0.12.19",
"tag": "@microsoft/tsdoc_v0.12.19",
"date": "Fri, 27 Mar 2020 23:14:53 GMT",
"comments": {
"patch": [
{
"comment": "Add some missing entries to TSDocConfiguration.allTsdocMessageIds() which were breaking eslint-plugin-tsdoc"
},
{
"comment": "Fix an issue where \"h1\" was not allowed as an HTML element name"
}
]
}
},
{
"version": "0.12.18",
"tag": "@microsoft/tsdoc_v0.12.18",
"date": "Sat, 22 Feb 2020 20:44:16 GMT",
"comments": {
"patch": [
{
"comment": "Fix an issue where JSDoc optional params were not parsed correctly"
}
]
}
},
{
"version": "0.12.17",
"tag": "@microsoft/tsdoc_v0.12.17",
"date": "Sat, 22 Feb 2020 02:55:07 GMT",
"comments": {
"patch": [
{
"comment": "Improve the parsing of `@param` and `@typeParam` tags to recognize legacy syntaxes"
}
]
}
},
{
"version": "0.12.16",
"tag": "@microsoft/tsdoc_v0.12.16",
"date": "Tue, 19 Nov 2019 22:01:56 GMT",
"comments": {
"patch": [
{
"comment": "Add some new TSDocMessageId definitions used by @microsoft/tsdoc-config"
}
]
}
},
{
"version": "0.12.15",
"tag": "@microsoft/tsdoc_v0.12.15",
"date": "Sat, 09 Nov 2019 05:55:42 GMT",
"comments": {
"patch": [
{
"comment": "Add new API TSDocConfiguration.allTsdocMessageIds"
}
]
}
},
{
"version": "0.12.14",
"tag": "@microsoft/tsdoc_v0.12.14",
"date": "Wed, 04 Sep 2019 03:30:10 GMT",
"comments": {
"patch": [
{
"comment": "Fix a regression where some API signatures were incompatible with TypeScript versions prior to 3.4"
}
]
}
},
{
"version": "0.12.13",
"tag": "@microsoft/tsdoc_v0.12.13",
"date": "Fri, 30 Aug 2019 18:38:59 GMT",
"comments": {
"patch": [
{
"comment": "Fix an invalid regular expression."
}
]
}
},
{
"version": "0.12.12",
"tag": "@microsoft/tsdoc_v0.12.12",
"date": "Wed, 07 Aug 2019 23:06:02 GMT",
"comments": {
"patch": [
{
"comment": "Improve DeclarationReference.parse for module sources"
},
{
"comment": "Add a definition for the `@throws` block tag (RFC 171)"
}
]
}
},
{
"version": "0.12.11",
"tag": "@microsoft/tsdoc_v0.12.11",
"date": "Wed, 24 Jul 2019 00:38:18 GMT",
"comments": {
"patch": [
{
"comment": "Add new meanings to DeclarationReference and fix some parsing bugs"
}
]
}
},
{
"version": "0.12.10",
"tag": "@microsoft/tsdoc_v0.12.10",
"date": "Fri, 19 Jul 2019 02:47:09 GMT",
"comments": {
"patch": [
{
"comment": "Add beta implementation of new DeclarationReference API"
}
]
}
},
{
"version": "0.12.9",
"tag": "@microsoft/tsdoc_v0.12.9",
"date": "Thu, 11 Apr 2019 03:58:35 GMT",
"comments": {
"patch": [
{
"comment": "Improve the wording of the error messages involving character sequences that look like TSDoc tags"
}
]
}
},
{
"version": "0.12.8",
"tag": "@microsoft/tsdoc_v0.12.8",
"date": "Tue, 12 Mar 2019 23:18:11 GMT",
"comments": {
"patch": [
{
"comment": "Fix an issue where tsdoc-param-tag-with-invalid-name was sometimes incorrectly reported certain identifiers (issue #148)"
}
]
}
},
{
"version": "0.12.7",
"tag": "@microsoft/tsdoc_v0.12.7",
"date": "Fri, 01 Mar 2019 06:39:52 GMT",
"comments": {
"patch": [
{
"comment": "Add new API TSDocConfiguration.isKnownMessageId()"
}
]
}
},
{
"version": "0.12.6",
"tag": "@microsoft/tsdoc_v0.12.6",
"date": "Thu, 28 Feb 2019 01:29:39 GMT",
"comments": {
"patch": [
{
"comment": "Add a new API ParserMessage.messageId with a unique ID useful for filtering and searching for errors"
}
]
}
},
{
"version": "0.12.5",
"tag": "@microsoft/tsdoc_v0.12.5",
"date": "Tue, 29 Jan 2019 22:49:58 GMT",
"comments": {
"patch": [
{
"comment": "Update parser to allow `$` character in `@param` names, since ECMAScript allows this in unquoted identifiers"
},
{
"comment": "Allow `$` character in declaration reference member identifiers (Example: `{@link Button.$render}`)"
}
]
}
},
{
"version": "0.12.4",
"tag": "@microsoft/tsdoc_v0.12.4",
"date": "Tue, 20 Nov 2018 21:23:06 GMT",
"comments": {
"patch": [
{
"comment": "Add new interface `IStringBuilder`"
}
]
}
},
{
"version": "0.12.3",
"tag": "@microsoft/tsdoc_v0.12.3",
"date": "Tue, 20 Nov 2018 07:42:17 GMT",
"comments": {
"patch": [
{
"comment": "Add a new API `PlainTextEmitter.hasAnyTextContent()`"
}
]
}
},
{
"version": "0.12.2",
"tag": "@microsoft/tsdoc_v0.12.2",
"date": "Fri, 09 Nov 2018 15:13:13 GMT",
"comments": {
"patch": [
{
"comment": "Improve trimming of spacing for link text in `{@link}` tags"
}
]
}
},
{
"version": "0.12.1",
"tag": "@microsoft/tsdoc_v0.12.1",
"date": "Tue, 06 Nov 2018 01:37:22 GMT",
"comments": {
"patch": [
{
"comment": "Allow HTML in a `DocSection` node"
},
{
"comment": "Fix a bug where `TSDocEmitter.renderHtmlTag()` and `TSDocEmitter.renderDeclarationReference()` were including comment framing"
},
{
"comment": "Add `DocSection.appendNodesInParagraph()` API"
}
]
}
},
{
"version": "0.12.0",
"tag": "@microsoft/tsdoc_v0.12.0",
"date": "Sat, 03 Nov 2018 02:07:10 GMT",
"comments": {
"patch": [
{
"comment": "Add `DocDeclarationReference.emitAsTsdoc()`, `DocHtmlStartTag.emitAsHtml()`, and `DocHtmlEndTag.emitAsHtml()`"
},
{
"comment": "Child nodes can now be specified as a second constructor parameter for `DocNodeContainer`"
}
],
"minor": [
{
"comment": "(API change) `DocErrorText` is no longer allowed in `DocSection`; instead it must be part of a `DocParagraph`"
},
{
"comment": "(API change) Rename `TSDocParserConfiguration` to `TSDocConfiguration`"
},
{
"comment": "(API change) Require an associated `TSDocConfiguration` to be included with the parameters for every `DocNode` constructor"
},
{
"comment": "Introduce `TSDocConfiguration.docNodeManager` for registering custom `DocNode` subclasses and their container relationships"
}
]
}
},
{
"version": "0.11.0",
"tag": "@microsoft/tsdoc_v0.11.0",
"date": "Sat, 27 Oct 2018 04:52:23 GMT",
"comments": {
"minor": [
{
"comment": "(API change) Introduce `DocParamCollection` to enable efficient lookups of parameters by name"
},
{
"comment": "(API change) Rename `DocComment.typeParamBlocks` --> `DocComment.typeParams`"
},
{
"comment": "(API change) Rename `DocComment.paramBlocks` --> `DocComment.params`"
}
]
}
},
{
"version": "0.10.0",
"tag": "@microsoft/tsdoc_v0.10.0",
"date": "Fri, 26 Oct 2018 08:42:51 GMT",
"comments": {
"minor": [
{
"comment": "Add new APIs `DocComment.emitAsTsdoc()`, `TSDocEmitter`, and `StringBuilder`"
}
]
}
},
{
"version": "0.9.3",
"tag": "@microsoft/tsdoc_v0.9.3",
"date": "Thu, 25 Oct 2018 08:29:36 GMT",
"comments": {
"patch": [
{
"comment": "Fix issue where `DocErrorText.text` returned `[object Object]` instead of the text"
}
]
}
},
{
"version": "0.9.2",
"tag": "@microsoft/tsdoc_v0.9.2",
"date": "Wed, 17 Oct 2018 13:41:54 GMT",
"comments": {
"patch": [
{
"comment": "Fix stack overflow in DocFencedCode.language property getter"
}
]
}
},
{
"version": "0.9.1",
"tag": "@microsoft/tsdoc_v0.9.1",
"date": "Wed, 17 Oct 2018 12:49:01 GMT",
"comments": {
"patch": [
{
"comment": "Fix a regression where the paragraph splitter was sometimes skipping blocks"
}
]
}
},
{
"version": "0.9.0",
"tag": "@microsoft/tsdoc_v0.9.0",
"date": "Wed, 17 Oct 2018 04:47:19 GMT",
"comments": {
"minor": [
{
"comment": "(API change) Change `DocBlock` to have a `DocSection` property rather than inheriting from `DocSection`; this eliminates confusion about which nodes belong to the container"
},
{
"comment": "(API change) Rename `DocParticle` to `DocExcerpt`, and eliminate the `Excerpt` class"
},
{
"comment": "(API change) Eliminate `DocNodeLeaf`, since now `DocExcerpt` is the only class that can represent excerpts"
},
{
"comment": "(API change) Remove `DocNode.updateParameters()` because it is no longer needed"
},
{
"comment": "(API change) Spacing is now represented as a normal `DocExcerpt`, rather than via a special `Excerpt.spacingAfterContent`"
},
{
"comment": "(API change) Simplify `DocNodeTransforms.trimSpacesInParagraph()` to no longer merge/remap excerpts during the transformation. If we need this information, we will track it differently."
}
]
}
},
{
"version": "0.8.1",
"tag": "@microsoft/api-extractor_v0.8.1",
"date": "Sun, 07 Oct 2018 06:30:34 GMT",
"comments": {
"patch": [
{
"comment": "Improve error reporting for declaration references that are probably missing a `\"#\"` delimiter"
},
{
"comment": "Rename `DocCodeFence` to `DocFencedCode`"
}
]
}
},
{
"version": "0.8.0",
"tag": "@microsoft/api-extractor_v0.8.0",
"date": "Wed, 03 Oct 2018 02:43:47 GMT",
"comments": {
"minor": [
{
"comment": "Introduce a distinction between \"defined\" tags (i.e. recognized) versus \"supported\" tags (i.e. implemented by the tool)"
},
{
"comment": "The parser optionally reports usage of undefined tags"
},
{
"comment": "The parser optionally reports usage of unsupported tags"
},
{
"comment": "The parser reports usage of inline/block syntax that is inconsistent with the tag definition"
},
{
"comment": "Code spans are now allowed to be adjacent to other text, but must contain at least one character"
},
{
"comment": "An `@deprecated` block must contain a deprecation message"
},
{
"comment": "If `@inheritDoc` is used, then the summary section must be empty, and there must not be an `@remarks` block"
}
]
}
},
{
"version": "0.7.0",
"tag": "@microsoft/api-extractor_v0.7.0",
"date": "Tue, 02 Oct 2018 02:35:35 GMT",
"comments": {
"minor": [
{
"comment": "Add support for `@defaultValue` tag"
},
{
"comment": "Add support for `@typeParam` tag"
}
]
}
},
{
"version": "0.6.0",
"tag": "@microsoft/api-extractor_v0.6.0",
"date": "Mon, 01 Oct 2018 22:11:24 GMT",
"comments": {
"minor": [
{
"comment": "Add support for `@link` tags using the new declaration reference syntax"
},
{
"comment": "Add support for `@inheritDoc` tags"
},
{
"comment": "Add new APIs: `DocDeclarationReference`, `DocInheritDocTag`, `DocLinkTag`, `DocMemberIdentifier`, `DocMemberReference`, `DocMemberSelector`, `DocMemberSymbol`"
},
{
"comment": "Remove `ParserContext.verbatimNodes`"
},
{
"comment": "Add `DocParticle.particleId` property"
}
]
}
},
{
"version": "0.5.0",
"tag": "@microsoft/api-extractor_v0.5.0",
"date": "Tue, 25 Sep 2018 03:04:06 GMT",
"comments": {
"minor": [
{
"comment": "Add a new API `DocNode.updateParameters()` that allows a `DocNode` object to be updated after it was created; the tree nodes are no longer immutable"
},
{
"comment": "Add `DocNodeTransforms.trimSpacesInParagraphNodes()` for collapsing whitespace inside `DocParagraph` subtrees"
},
{
"comment": "Extract the `DocNode.excerpt` property into a new abstract base class `DocNodeLeaf`"
}
]
}
},
{
"version": "0.4.1",
"tag": "@microsoft/api-extractor_v0.4.1",
"date": "Fri, 31 Aug 2018 03:32:18 GMT",
"comments": {
"patch": [
{
"comment": "Improve the error location reporting for DocErrorText objects"
},
{
"comment": "Separate the **api-demo** sample into a \"simple\" scenario which parses a simple text string, and an \"advanced\" scenario which uses the TypeScript compiler API to extract comments and parse custom TSDoc tags"
}
]
}
},
{
"version": "0.4.0",
"tag": "@microsoft/api-extractor_v0.4.0",
"date": "Tue, 28 Aug 2018 03:17:20 GMT",
"comments": {
"minor": [
{
"comment": "Rename `DocCodeSpan.text` to `DocCodeSpan.code` and model the delimiters using particles"
},
{
"comment": "Add support for code fences (`DocCodeFence`)"
},
{
"comment": "`DocSection` content is now grouped into `DocParagraph` nodes; blank lines are used to indicate paragraph boundaries"
},
{
"comment": "Rename `DocComment.deprecated` to `deprecatedBlock`"
}
]
}
},
{
"version": "0.3.0",
"tag": "@microsoft/api-extractor_v0.3.0",
"date": "Sat, 25 Aug 2018 05:53:56 GMT",
"comments": {
"minor": [
{
"comment": "Add TextRange.isEmpty()"
},
{
"comment": "Improve the ModifierTagSet API"
},
{
"comment": "Implement the @privateRemarks and @deprecated tags"
}
]
}
},
{
"version": "0.2.0",
"tag": "@microsoft/api-extractor_v0.2.0",
"date": "Fri, 24 Aug 2018 01:19:56 GMT",
"comments": {
"minor": [
{
"comment": "Rename `CoreTags` to `StandardTags` so we can include non-core tags in the standard definitions"
},
{
"comment": "Rename `CoreModifierTagSet` to `StandardModifierTagSet` and convert properties to functions"
},
{
"comment": "Categorize the standard tags according to a `Standardization` enum, and document them"
},
{
"comment": "Add more standard tag definitions: `@deprecated`, `@eventProperty`, `@example`, `@inheritDoc`, `@link`, `@override`, `@packageDocumentation`, `@public`, `@privateRemarks`, `@sealed`, `@virtual`"
},
{
"comment": "Replace TSDocTagDefinition.singleton with TSDocTagDefinition.allowMultiple, since in practice most tags are single-usage"
}
]
}
},
{
"version": "0.1.0",
"tag": "@microsoft/api-extractor_v0.1.0",
"date": "Thu, 16 Aug 2018 18:18:02 GMT",
"comments": {
"minor": [
{
"comment": "Initial release of the TSDoc library! :-)"
}
]
}
}
]
}
|