Compare commits

...

3 Commits

Author SHA1 Message Date
b76e772ee2 additional model methods 2024-02-11 02:40:26 +01:00
f919dde7fa clean up: consistant format 2024-02-11 02:40:10 +01:00
76526e08b9 remove old docs on jsdoc script execution 2024-02-11 02:39:52 +01:00
5 changed files with 11 additions and 3 deletions

View File

@ -3,6 +3,7 @@ import defineVoiceChannel from './models/voiceChannels.js';
import defineMessage from './models/messages.js'; import defineMessage from './models/messages.js';
import { Sequelize } from 'sequelize'; import { Sequelize } from 'sequelize';
import { config } from 'dotenv'; import { config } from 'dotenv';
config(); config();
const { DB_NAME } = process.env; const { DB_NAME } = process.env;

View File

@ -3,8 +3,9 @@ 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.
* @method hasMany Defines an One-To-Many relationship. * @property {(model: Object) => void} hasMany Defines an One-To-Many relationship.
* @param {Object} * @property {(conditions: Object) => void} 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).
*/ */
/** /**

View File

@ -6,6 +6,9 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize';
* @property {string} message A Discord message ID as a foreign key reference. * @property {string} message A Discord message ID as a foreign key reference.
* @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 {(conditions: Object) => void} 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).
*/ */
/** /**

View File

@ -5,6 +5,9 @@ import { DataTypes, Sequelize } from 'sequelize';
* @property {string} id A Discord channel ID. * @property {string} id A Discord channel ID.
* @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 {(conditions: Object) => void} 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).
*/ */
/** /**

View File

@ -9,7 +9,7 @@
"deploy": "node deploy.js", "deploy": "node deploy.js",
"lint": "prettier --check . && eslint .", "lint": "prettier --check . && eslint .",
"format": "prettier --write .", "format": "prettier --write .",
"jsdoc": "jsdoc -c ./.jsdoc.conf.json -d docs/ -r ." "jsdoc": "rm -rf docs/ && jsdoc -c ./.jsdoc.conf.json -d docs/ -r ."
}, },
"author": "", "author": "",
"license": "ISC", "license": "ISC",