docs(ThreadManager): fix FetchedThreads typedef and startMessage (#5971)

This commit is contained in:
Shubham Parihar
2021-06-30 21:50:01 +05:30
committed by GitHub
parent b7ed6752ac
commit f108746c15

View File

@@ -74,8 +74,7 @@ class ThreadManager extends BaseManager {
* @typedef {Object} ThreadCreateOptions * @typedef {Object} ThreadCreateOptions
* @property {string} name The name of the new Thread * @property {string} name The name of the new Thread
* @property {ThreadAutoArchiveDuration} autoArchiveDuration How long before the thread is automatically archived * @property {ThreadAutoArchiveDuration} autoArchiveDuration How long before the thread is automatically archived
* @property {MessageResolvable} [startMessage] The message to start a public or news thread from, * @property {MessageResolvable} [startMessage] The message to start a thread from
* creates a private thread if not provided
* @property {ThreadChannelType|number} [type='public_thread'] The type of thread to create * @property {ThreadChannelType|number} [type='public_thread'] The type of thread to create
* <warn>When creating threads in a `news` channel this is ignored and is always `news_thread`</warn> * <warn>When creating threads in a `news` channel this is ignored and is always `news_thread`</warn>
* @property {string} [reason] Reason for creating the thread * @property {string} [reason] Reason for creating the thread
@@ -186,7 +185,7 @@ class ThreadManager extends BaseManager {
/** /**
* The data returned from a thread fetch that returns multiple threads. * The data returned from a thread fetch that returns multiple threads.
* @typedef {FetchedThreads} * @typedef {Object} FetchedThreads
* @property {Collection<Snowflake, ThreadChannel>} threads The threads fetched, with any members returned * @property {Collection<Snowflake, ThreadChannel>} threads The threads fetched, with any members returned
* @property {?boolean} hasMore Whether there are potentially additional threads that require a subsequent call * @property {?boolean} hasMore Whether there are potentially additional threads that require a subsequent call
*/ */