chore: add proper documentation (#763)

* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
This commit is contained in:
Luan
2024-09-23 17:32:50 -03:00
committed by GitHub
parent dd7f5cf778
commit 74659fd03f
853 changed files with 139814 additions and 1929 deletions

View File

@@ -53,7 +53,7 @@ export default class ChannelAboutFullMetadata extends YTNode {
/**
* @deprecated
* This will be removed in a future release.
* Please use {@link Channel.view_count} instead.
* Please use {@link ChannelAboutFullMetadata.view_count} instead.
*/
get views() {
Log.warnOnce(ChannelAboutFullMetadata.type, 'ChannelAboutFullMetadata#views is deprecated. Please use ChannelAboutFullMetadata#view_count instead.');
@@ -63,7 +63,7 @@ export default class ChannelAboutFullMetadata extends YTNode {
/**
* @deprecated
* This will be removed in a future release.
* Please use {@link Channel.joined_date} instead.
* Please use {@link ChannelAboutFullMetadata.joined_date} instead.
*/
get joined(): Text {
Log.warnOnce(ChannelAboutFullMetadata.type, 'ChannelAboutFullMetadata#joined is deprecated. Please use ChannelAboutFullMetadata#joined_date instead.');