diff options
author | IRONM00N <64110067+IRONM00N@users.noreply.github.com> | 2022-02-04 14:08:09 -0500 |
---|---|---|
committer | IRONM00N <64110067+IRONM00N@users.noreply.github.com> | 2022-02-04 14:08:09 -0500 |
commit | d5d5fd6f77f2d778ab099d52f1acaad762712822 (patch) | |
tree | ababfba81c28c102b932e2713c1614260a424285 /src/lib/models/shared | |
parent | e5bc336f9586b1f5515be3f1d239d2194489e9c5 (diff) | |
download | tanzanite-d5d5fd6f77f2d778ab099d52f1acaad762712822.tar.gz tanzanite-d5d5fd6f77f2d778ab099d52f1acaad762712822.tar.bz2 tanzanite-d5d5fd6f77f2d778ab099d52f1acaad762712822.zip |
explicit member accessibility & jsdocs & typings
Diffstat (limited to 'src/lib/models/shared')
-rw-r--r-- | src/lib/models/shared/Global.ts | 3 | ||||
-rw-r--r-- | src/lib/models/shared/Shared.ts | 3 | ||||
-rw-r--r-- | src/lib/models/shared/Stat.ts | 3 |
3 files changed, 9 insertions, 0 deletions
diff --git a/src/lib/models/shared/Global.ts b/src/lib/models/shared/Global.ts index 6dfc36f..b1aa0cc 100644 --- a/src/lib/models/shared/Global.ts +++ b/src/lib/models/shared/Global.ts @@ -19,6 +19,9 @@ export interface GlobalModelCreationAttributes { blacklistedChannels?: Snowflake[]; } +/** + * Data specific to a certain instance of the bot. + */ export class Global extends BaseModel<GlobalModel, GlobalModelCreationAttributes> implements GlobalModel { /** * The bot's environment. diff --git a/src/lib/models/shared/Shared.ts b/src/lib/models/shared/Shared.ts index 642ff85..4d13011 100644 --- a/src/lib/models/shared/Shared.ts +++ b/src/lib/models/shared/Shared.ts @@ -24,6 +24,9 @@ export interface SharedModelCreationAttributes { autoBanCode?: string; } +/** + * Data shared between all bot instances. + */ export class Shared extends BaseModel<SharedModel, SharedModelCreationAttributes> implements SharedModel { /** * The primary key of the shared model. diff --git a/src/lib/models/shared/Stat.ts b/src/lib/models/shared/Stat.ts index 8f77b58..d138620 100644 --- a/src/lib/models/shared/Stat.ts +++ b/src/lib/models/shared/Stat.ts @@ -14,6 +14,9 @@ export interface StatModelCreationAttributes { commandsUsed?: bigint; } +/** + * Statistics for each instance of the bot. + */ export class Stat extends BaseModel<StatModel, StatModelCreationAttributes> implements StatModel { /** * The bot's environment. |