With IntelliSense support & test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses, built-in rate-limit handling, flexible cache support, and helper functions.
If a declaration has multiple comments associated with it, the last one should be used, #1961.
v0.23.0
Breaking Changes
Node 12 is no longer officially supported as it has gone end of life as of 2022-04-30. It might still work, but may stop working at any time.
Dropped support for TypeScript before 4.6.
{@link} tags in comments will now be resolved as declaration references similar to TSDoc's declaration references.
For most cases, this will just work. See the documentation for details on how link resolution works.
TypeDoc will now produce warnings for bracketed links ([[ target ]]). Use {@link target} instead. The {@link} syntax will be recognized by TypeScript 4.3 and later and used to provide better intellisense. TypeDoc version 0.24.0 will remove support for [[ target ]] style links.
extends in typedoc.json is now resolved using NodeJS module resolution, so a local path must begin with ./.
In the JSON output for DeclarationReflections, getSignature is no longer a one-tuple.
In the JSON output for DeclarationReflections, setSignature is no longer a one-tuple.
In the JSON output for DeclarationReflections, typeParameter has been renamed to typeParameters
The searchGroupBoosts option must now be given the rendered group name rather than reflection kind names, and can be given custom group names.
@inheritDoc now follows the behavior specified by TSDoc when copying comments with a reference.
The gaSite option has been removed since Google Analytics now infers the site automatically, updated Google Analytics script to latest version, #1846.
Comments on export declarations will only overrides comments for references and namespaces, #1901.
The deprecated listInvalidSymbolLinks option has been removed. Use validation.invalidLink instead.
The deprecated true and false values have been removed from --emit, to migrate replace true with "both" and false with "docs" (the default).
Links are no longer be resolved against a global list of all symbols. See the documentation for details on link resolution.
The validation.invalidLink option is now on by default.
reflection.decorates, reflection.decorators, and their corresponding interfaces have been removed as no code in TypeDoc used them.
The shape of the Comment class has changed significantly to support multiple tag kinds.
Listeners to Converter.EVENT_CREATE_TYPE_PARAMETER and Converter.EVENT_CREATE_DECLARATION will now never be passed a ts.Node as their third argument.
Constant variables which are interpreted as functions will no longer have the ReflectionFlag.Const flag set.
reflection.defaultValue is no longer set for enum members. The same information is available on reflection.type with more precision.
Removed deprecated removeReaderByName, addDeclarations and removeDeclarationByName methods on Options.
Removed ProjectReflection.directory, it was unused by TypeDoc and not properly tested.
Removed ProjectReflection.files, this was an internal cache that should not have been exposed, and shouldn't have existed in the first place, since removing it made TypeDoc faster.
Removed ReflectionGroup.kind since groups can now be created with the @group tag.
Removed ReflectionKind.Event, the @event tag is now an alias for @group Events. Note: This changes the value of ReflectionKind.Reference from 16777216 to 8388608.
Themes are now set on the document element rather than on body, #1706.
Features
TypeDoc now supports the @group tag to group reflections in a page. If no @group tag is specified, reflections will be grouped according to their kind, #1652.
TypeDoc will now search for typedoc.js(on) in the .config folder in the current working directory.
Entry point strategies Resolve and Expand may now specify globs, #1926.
typedoc.json now supports comments like tsconfig.json.
TypeDoc will now read the blockTags, inlineTags, and modifierTags out of tsdoc.json in the same directory as tsconfig.json if it exists.
It is recommended to add "extends": ["typedoc/tsdoc.json"], which defines TypeDoc specific tags to your tsdoc.json if you create one.
If an exported symbol has multiple declarations, TypeDoc will now check all appropriate declarations for comments, and warn if more than one declaration contains a comment, #1855.
Improved support for JSDoc style @example tags. If the tag content does not include a code block, TypeDoc now follows VSCode's behavior of treating the entire block as a code block, #135.
TypeDoc will now render members marked with @deprecated with a line through their name, #1381.
If a declaration has multiple comments associated with it, the last one should be used, #1961.
v0.23.0 (2022-06-26)
Breaking Changes
Node 12 is no longer officially supported as it has gone end of life as of 2022-04-30. It might still work, but may stop working at any time.
Dropped support for TypeScript before 4.6.
{@link} tags in comments will now be resolved as declaration references similar to TSDoc's declaration references.
For most cases, this will just work. See the documentation for details on how link resolution works.
TypeDoc will now produce warnings for bracketed links ([[ target ]]). Use {@link target} instead. The {@link} syntax will be recognized by TypeScript 4.3 and later and used to provide better intellisense. TypeDoc version 0.24.0 will remove support for [[ target ]] style links.
extends in typedoc.json is now resolved using NodeJS module resolution, so a local path must begin with ./.
In the JSON output for DeclarationReflections, getSignature is no longer a one-tuple.
In the JSON output for DeclarationReflections, setSignature is no longer a one-tuple.
In the JSON output for DeclarationReflections, typeParameter has been renamed to typeParameters
The searchGroupBoosts option must now be given the rendered group name rather than reflection kind names, and can be given custom group names.
@inheritDoc now follows the behavior specified by TSDoc when copying comments with a reference.
The gaSite option has been removed since Google Analytics now infers the site automatically, updated Google Analytics script to latest version, #1846.
Comments on export declarations will only overrides comments for references and namespaces, #1901.
The deprecated listInvalidSymbolLinks option has been removed. Use validation.invalidLink instead.
The deprecated true and false values have been removed from --emit, to migrate replace true with "both" and false with "docs" (the default).
Links are no longer be resolved against a global list of all symbols. See the documentation for details on link resolution.
The validation.invalidLink option is now on by default.
reflection.decorates, reflection.decorators, and their corresponding interfaces have been removed as no code in TypeDoc used them.
The shape of the Comment class has changed significantly to support multiple tag kinds.
Listeners to Converter.EVENT_CREATE_TYPE_PARAMETER and Converter.EVENT_CREATE_DECLARATION will now never be passed a ts.Node as their third argument.
Constant variables which are interpreted as functions will no longer have the ReflectionFlag.Const flag set.
reflection.defaultValue is no longer set for enum members. The same information is available on reflection.type with more precision.
Removed deprecated removeReaderByName, addDeclarations and removeDeclarationByName methods on Options.
Removed ProjectReflection.directory, it was unused by TypeDoc and not properly tested.
Removed ProjectReflection.files, this was an internal cache that should not have been exposed, and shouldn't have existed in the first place, since removing it made TypeDoc faster.
Removed ReflectionGroup.kind since groups can now be created with the @group tag.
Removed ReflectionKind.Event, the @event tag is now an alias for @group Events. Note: This changes the value of ReflectionKind.Reference from 16777216 to 8388608.
Themes are now set on the document element rather than on body, #1706.
Features
TypeDoc now supports the @group tag to group reflections in a page. If no @group tag is specified, reflections will be grouped according to their kind, #1652.
TypeDoc will now search for typedoc.js(on) in the .config folder in the current working directory.
Entry point strategies Resolve and Expand may now specify globs, #1926.
typedoc.json now supports comments like tsconfig.json.
TypeDoc will now read the blockTags, inlineTags, and modifierTags out of tsdoc.json in the same directory as tsconfig.json if it exists.
It is recommended to add "extends": ["typedoc/tsdoc.json"], which defines TypeDoc specific tags to your tsdoc.json if you create one.
If an exported symbol has multiple declarations, TypeDoc will now check all appropriate declarations for comments, and warn if more than one declaration contains a comment, #1855.
Improved support for JSDoc style @example tags. If the tag content does not include a code block, TypeDoc now follows VSCode's behavior of treating the entire block as a code block, #135.
TypeDoc will now render members marked with @deprecated with a line through their name, #1381.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
dependabot[bot]
commented
2 years ago
Bumps typedoc from 0.20.34 to 0.23.1.
Release notes
Sourced from typedoc's releases.
... (truncated)
Changelog
Sourced from typedoc's changelog.
... (truncated)
Commits
afd5b5bUpdate changelog for release95539feBump version to 0.23.1b6d1bddFix comment discovery if there are multiple comments9515e99Update changelog for release1486da7Bump version to 0.23.056517efMerge pull request #1760 from TypeStrong/betaf38ad6fUpdate changelog5f6c9beMerge remote-tracking branch 'origin/master' into beta95a7155Merge pull request #1960 from shmax/fix-category-boost95f95b3use category name directlyDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)