Baipyrus/DiscordJS-Example
1
0
Fork 0
generated from Baipyrus/DiscordJS-Template
Code Issues Pull Requests Packages Projects Releases Wiki Activity

correct typing on typedef methods

Browse Source
This commit is contained in:
Baipyrus 2024-02-11 02:53:28 +01:00
parent b76e772ee2
commit bdb08c1810
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
models/messages.js
View File

@ -4,8 +4,8 @@ import { DataTypes, Sequelize } from 'sequelize';
* @typedef {Object} Message * @typedef {Object} Message
* @property {string} id A Discord message ID. * @property {string} id A Discord message ID.
* @property {(model: Object) => void} hasMany Defines an One-To-Many relationship. * @property {(model: Object) => void} hasMany Defines an One-To-Many relationship.
* @property {(conditions: Object) => void} findOne Finds one instance in the database matching the provided condition(-s). * @property {(conditions: Object) => Promise<Message>} findOne Finds one instance in the database matching the provided condition(-s).
* @property {(conditions: Object) => void} findAll Finds all instances in the database matching the provided condition(-s). * @property {(conditions: Object) => Promise<Array<Message>>} findAll Finds all instances in the database matching the provided condition(-s).
*/ */
/** /**
@ -13,7 +13,7 @@ import { DataTypes, Sequelize } from 'sequelize';
* @param {Sequelize} sequelize * @param {Sequelize} sequelize
* @returns {Message} * @returns {Message}
*/ */
export default function (sequelize) { export default function(sequelize) {
return sequelize.define('Messages', { return sequelize.define('Messages', {
id: { id: {
type: DataTypes.STRING, type: DataTypes.STRING,

6
models/roleEmojiPairs.js
View File

@ -7,8 +7,8 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize';
* @property {string} role A Discord role ID. * @property {string} role A Discord role ID.
* @property {string} emoji Either a unicode emoji or a string representation in Discord custom emoji format. * @property {string} emoji Either a unicode emoji or a string representation in Discord custom emoji format.
* @property {(model: Object) => void} hasMany Defines an One-To-Many relationship. * @property {(model: Object) => void} hasMany Defines an One-To-Many relationship.
* @property {(conditions: Object) => void} findOne Finds one instance in the database matching the provided condition(-s). * @property {(conditions: Object) => Promise<RoleEmojiPair>} findOne Finds one instance in the database matching the provided condition(-s).
* @property {(conditions: Object) => void} findAll Finds all instances in the database matching the provided condition(-s). * @property {(conditions: Object) => Promise<Array<RoleEmojiPair>>} findAll Finds all instances in the database matching the provided condition(-s).
*/ */
/** /**
@ -16,7 +16,7 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize';
* @param {Sequelize} sequelize * @param {Sequelize} sequelize
* @returns {RoleEmojiPair} * @returns {RoleEmojiPair}
*/ */
export default function (sequelize) { export default function(sequelize) {
return sequelize.define('RoleEmojiPairs', { return sequelize.define('RoleEmojiPairs', {
id: { id: {
defaultValue: DataTypes.UUIDV4, defaultValue: DataTypes.UUIDV4,

6
models/voiceChannels.js
View File

@ -6,8 +6,8 @@ import { DataTypes, Sequelize } from 'sequelize';
* @property {boolean} create Whether or not this channel is registered to create customs when joined. * @property {boolean} create Whether or not this channel is registered to create customs when joined.
* @property {(string|null)} owner The owner of this channel, if not registered for customs. * @property {(string|null)} owner The owner of this channel, if not registered for customs.
* @property {(model: Object) => void} hasMany Defines an One-To-Many relationship. * @property {(model: Object) => void} hasMany Defines an One-To-Many relationship.
* @property {(conditions: Object) => void} findOne Finds one instance in the database matching the provided condition(-s). * @property {(conditions: Object) => Promise<VoiceChannel>} findOne Finds one instance in the database matching the provided condition(-s).
* @property {(conditions: Object) => void} findAll Finds all instances in the database matching the provided condition(-s). * @property {(conditions: Object) => Promise<Array<VoiceChannel>>} findAll Finds all instances in the database matching the provided condition(-s).
*/ */
/** /**
@ -15,7 +15,7 @@ import { DataTypes, Sequelize } from 'sequelize';
* @param {Sequelize} sequelize * @param {Sequelize} sequelize
* @returns {VoiceChannel} * @returns {VoiceChannel}
*/ */
export default function (sequelize) { export default function(sequelize) {
return sequelize.define('VoiceChannel', { return sequelize.define('VoiceChannel', {
id: { id: {
type: DataTypes.STRING, type: DataTypes.STRING,