Repository: discordjs/discord.js
File: packages/discord.js/src/managers/GuildScheduledEventManager.js (JavaScript)

Code before:

  /**
   * The cache of this manager
   * @type {Collection<Snowflake, GuildScheduledEvent>}
   * @name GuildScheduledEventManager#cache
   */

  /**
   * Data that resolves to give a GuildScheduledEvent object. This can be:
   * * A Snowflake
   * * A GuildScheduledEvent object
   * @typedef {Snowflake|GuildScheduledEvent} GuildScheduledEventResolvable
   */

  /**
   * Options for setting a recurrence rule for a guild scheduled event.
   * @typedef {Object} GuildScheduledEventRecurrenceRuleOptions
   * @property {DateResolvable} startAt The time the recurrence rule interval starts at
   * @property {?DateResolvable} endAt The time the recurrence rule interval ends at
   * @property {GuildScheduledEventRecurrenceRuleFrequency} frequency How often the event occurs
   * @property {number} interval The spacing between the events
   * @property {?(GuildScheduledEventRecurrenceRuleWeekday[])} byWeekday The days within a week to recur on
   * @property {?(GuildScheduledEventRecurrenceRuleNWeekday[])} byNWeekday The days within a week to recur on
   * @property {?(GuildScheduledEventRecurrenceRuleMonth[])} byMonth The months to recur on
   * @property {?(number[])} byMonthDay The days within a month to recur on
   * @property {?(number[])} byYearDay The days within a year to recur on
   * @property {?number} count The total amount of times the event is allowed to recur before stopping
   */

  /**
   * Options used to create a guild scheduled event.
   * @typedef {Object} GuildScheduledEventCreateOptions
   * @property {string} name The name of the guild scheduled event
   * @property {DateResolvable} scheduledStartTime The time to schedule the event at
   * @property {DateResolvable} [scheduledEndTime] The time to end the event at
   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.External}</warn>
   * @property {GuildScheduledEventPrivacyLevel} privacyLevel The privacy level of the guild scheduled event
   * @property {GuildScheduledEventEntityType} entityType The scheduled entity type of the event
   * @property {string} [description] The description of the guild scheduled event
   * @property {GuildVoiceChannelResolvable} [channel] The channel of the guild scheduled event
   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.StageInstance} or
   * {@link GuildScheduledEventEntityType.Voice}</warn>
   * @property {GuildScheduledEventEntityMetadataOptions} [entityMetadata] The entity metadata of the
   * guild scheduled event
   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.External}</warn>
   * @property {?(BufferResolvable|Base64Resolvable)} [image] The cover image of the guild scheduled event
   * @property {string} [reason] The reason for creating the guild scheduled event
   * @property {GuildScheduledEventRecurrenceRuleOptions} [recurrenceRule]
   * The recurrence rule of the guild scheduled event
   */


Review comment (suggestion):
```suggestion
   * @property {?GuildScheduledEventRecurrenceRuleWeekday[]} byWeekday The days within a week to recur on
   * @property {?GuildScheduledEventRecurrenceRuleNWeekday[]} byNWeekday The days within a week to recur on
   * @property {?GuildScheduledEventRecurrenceRuleMonth[]} byMonth The months to recur on
   * @property {?number[]} byMonthDay The days within a month to recur on
   * @property {?number[]} byYearDay The days within a year to recur on
```

Code after:

  /**
   * The cache of this manager
   * @type {Collection<Snowflake, GuildScheduledEvent>}
   * @name GuildScheduledEventManager#cache
   */

  /**
   * Data that resolves to give a GuildScheduledEvent object. This can be:
   * * A Snowflake
   * * A GuildScheduledEvent object
   * @typedef {Snowflake|GuildScheduledEvent} GuildScheduledEventResolvable
   */

  /**
   * Options for setting a recurrence rule for a guild scheduled event.
   * @typedef {Object} GuildScheduledEventRecurrenceRuleOptions
   * @property {DateResolvable} startAt The time the recurrence rule interval starts at
   * @property {?DateResolvable} endAt The time the recurrence rule interval ends at
   * @property {GuildScheduledEventRecurrenceRuleFrequency} frequency How often the event occurs
   * @property {number} interval The spacing between the events
   * @property {?GuildScheduledEventRecurrenceRuleWeekday[]} byWeekday The days within a week to recur on
   * @property {?GuildScheduledEventRecurrenceRuleNWeekday[]} byNWeekday The days within a week to recur on
   * @property {?GuildScheduledEventRecurrenceRuleMonth[]} byMonth The months to recur on
   * @property {?number[]} byMonthDay The days within a month to recur on
   * @property {?number[]} byYearDay The days within a year to recur on
   * @property {?number} count The total amount of times the event is allowed to recur before stopping
   */

  /**
   * Options used to create a guild scheduled event.
   * @typedef {Object} GuildScheduledEventCreateOptions
   * @property {string} name The name of the guild scheduled event
   * @property {DateResolvable} scheduledStartTime The time to schedule the event at
   * @property {DateResolvable} [scheduledEndTime] The time to end the event at
   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.External}</warn>
   * @property {GuildScheduledEventPrivacyLevel} privacyLevel The privacy level of the guild scheduled event
   * @property {GuildScheduledEventEntityType} entityType The scheduled entity type of the event
   * @property {string} [description] The description of the guild scheduled event
   * @property {GuildVoiceChannelResolvable} [channel] The channel of the guild scheduled event
   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.StageInstance} or
   * {@link GuildScheduledEventEntityType.Voice}</warn>
   * @property {GuildScheduledEventEntityMetadataOptions} [entityMetadata] The entity metadata of the
   * guild scheduled event
   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.External}</warn>
   * @property {?(BufferResolvable|Base64Resolvable)} [image] The cover image of the guild scheduled event
   * @property {string} [reason] The reason for creating the guild scheduled event
   * @property {GuildScheduledEventRecurrenceRuleOptions} [recurrenceRule]
   * The recurrence rule of the guild scheduled event
   */