ts 👀

[paper spoke]

Hey, I'm using jsdoc with some of my functions. Is it possible to type a mongodb document using it? Since if I import the model it just isn't 100% correct

[warm hare]

• Consider reading #how-to-get-help to improve your question!
• Explain what exactly your issue is.
• Post the full error stack trace, not just the top part!
• Show your code!
• Issue solved? Press the button!

[paper spoke]

Well, "type"

This is my model

const mongoose = require("mongoose");

const schema = new mongoose.Schema({
    guildId: {
        type: String, unique: true
    },
    userId: {
        type: String
    },
    level: {
        type: Number,
        default: 0
    },
    exp: {
        type: Number,
        default: 0
    },
    weeklyExp: {
        type: Number,
        default: 0
    },
});
module.exports = mongoose.model("levelling", schema);

Was gonna use it in something like this

    /**
     * @param {GuildMember} member 
     * @param {TextChannel} channel 
     * @param {type} settings 
     */
    calculateXptoAdd(member, channel, settings = []) {
 //code
    }

What I'm gonna pass will look something like this:

[
    { type: 'role', id: '1045819599955963906', amount: '5' },
    { type: 'channel', id: '1092045790270197770', amount: '1' },
    { type: 'role', id: '977826521165205524', amount: '100' }
  ]

[brazen hill]

That schema and your variable you pass have no resemblance, so how did you expect that to work?

[paper spoke]

I was just giving that for context 😅

Probably wasn’t necessary

I honestly wanna move to ts at this rate but it will be painful to rewrite my bot in it when I don’t know much of it yet

[brazen hill]

You won’t have to rewrite it fully. First step is just installing typescript, tsc init to get a tsconfig and add allowJs: true. Then you can start gradually renaming to .ts and adding types to parameters (and then fixing any issues your js code had but you never knew about because you didn’t have ts)

[paper spoke]

How will that work? Like do I have to compile everything?

Since I bet you can’t really type with jsdoc like I want to

[brazen hill]

You can

But ts is better

[paper spoke]

As always 😂

How will working with ts and js work

[brazen hill]

djs is typed with JSDoc after all

[brazen hill]

👆that’s literally all you need

[paper spoke]

How can I type an array that will have this stuff

[paper spoke]

Yh but if I add a ts file, how will I run the bot? As node . Wont work right? Since I’ll have to compile the ts to js for those ts files

[brazen hill]

https://github.com/discordjs/discord.js/blob/778df451663d04cd1fb5818ef4dcdd01a7b90cc1/packages/discord.js/src/managers/ApplicationCommandManager.js#L150 for reference, this is how you can type an array of a type you define in another JSDoc comment before (scroll up to find how)

[brazen hill]

Yes, tsc will transpile those for you. Ts is only for development, you run js files either way

Unless you use deno or bun to run ts directly.

[paper spoke]

so node . Will work or won’t?

[paper spoke]

So djs has structures for things and uses typedef with jsdoc?

[brazen hill]

After running tsc (and configuring the main entry point in package.json correctly) yes. Better to set a npm script to run though

Can also use tsc --watch to have it transpile on every file save

[paper spoke]

Ah, is that where people have like a dist folder of just the fully compiled code and run that

[brazen hill]

Yes. That’s what tsc does for you

[paper spoke]

Ahh gotcha

Then to run it’ll just be node ./dist/index.js

If I’m in the main folder

[brazen hill]

Best way is to put ./dist/index.js in your package.json as main, then it‘ll just be node .

[paper spoke]

Ahhhhhhh

I didn’t know you could do that 💀

Alright thanks

I’ll clone my main bot folder on my laptop and give it a go later or tomorrow or whatever

The hard thing will be to learn how to type mongo documents but the site has a guide on how to use ts with mongoose

[brazen hill]

Afaik mongoose is typed so you wouldn’t even need to do anything once you use it in typescript it‘ll just work

[paper spoke]

Idk if yoy need to or not but I think you need to add stuff into the thing

Idk the words

Err

Nvm

[paper spoke]

ts 👀

[knotty urchin]

Its typed yes , but the schema if you do it in TS directly it will not look like the one in js
example in ts :

import type { blacklistUsers } from '#type/index.js';
import { model, Schema } from 'mongoose';

const blacklist = new Schema<blacklistUsers>({
    guildID: { type: String },
    ID: { type: String },
    reason: { type: String },
});
export default model<blacklistUsers>('userBlacklist', blacklist);

// The following stuff is in another file 

export interface blacklistUsers {
    guildID: string;
    ID: string;
    reason?: string;
}

[paper spoke]

Yh I saw this 😅, why would you do it in another file though?

Or do you not have to

As they also say to extent the interface

err

import { HydratedDocument } from 'mongoose';

interface IUser {
  name: string;
  email: string;
  avatar?: string;
}

const user: HydratedDocument<IUser> = new User({
  name: 'Bill',
  email: '[e-mail]',
  avatar: 'https://i.imgur.com/dM7Thhn.png'
});

[knotty urchin]

Just for me being cleaner , all my interfaces for my db is in 1 file

[paper spoke]

fair

[paper spoke]

do you know about this stuff btw

or is it not neccesary to use this HydratedDocument thing

[knotty urchin]

i used mongoose with TS so , i know a bit XD

i never used that form of writing tho const user: HydratedDocument<IUser> = new User({}) , i used it like i sent it earlier

//blacklist.ts
import type { blacklistUsers } from '#type/index.js'; //(Interface import)
import { model, Schema } from 'mongoose';

const blacklist = new Schema<blacklistUsers>({
    guildID: { type: String },
    ID: { type: String },
    reason: { type: String },
});
export default model<blacklistUsers>('userBlacklist', blacklist);

// ------------------- database.d.ts

export interface blacklistUsers {
    guildID: string;
    ID: string;
    reason?: string;
}

// ------------------- blacklist slash command
import blacklistUser from '#database/blacklistUser.js'; //(You import your schema made earlier)
...
await blacklistUser.create({
        guildID: interaction.guild.id,
        ID: interaction.user.id,
        reason: reason,
    });

[vague dew]

🍇

[paper spoke]

so just use normal interface's rather then the hydrated doc crap

[knotty urchin]

you can yea

[paper spoke]

idek what the hydrated thing does you see

[knotty urchin]

as i can see i think it replace the .create({})

i just think, im not sure about that

[paper spoke]

why do i get this error even though it's literally the correct path

[vague dew]

Did you module.exports (export default (for TS)) correctly

[paper spoke]

AH

fuck this is gonna be fun

im so stupid

LMAO

[vague dew]

(Recommendation) You should use ts-node instead of having a dist since its faster and you dont need to replace .ts in filenames with .js every time

[paper spoke]

i just compile everything

[vague dew]

I'll be honest I used to rm -rf my ./dist then tsc 💀

[paper spoke]

it's what Qjuh said to do

[vague dew]

Is it efficient though?

It takes like a few seconds

[paper spoke]

yh takes a few secs

idm that

[knotty urchin]

you import from src/Level/Level
but you show dist/Level/Level

[paper spoke]

yh that's my non compiled stuff, probably should have shown the other one lol

i9 was right

was still using module.exports 💀🤣

[knotty urchin]

Oh , yeah it doesnt help xD

[vague dew]

They use tsc

[vague dew]

I used to debug that for hours 💀

[paper spoke]

😭

[jovial kernel]

ts-node for dev is ok but slow for prod

[vague dew]

So I should run this every time I start my bot?:
rm -rf ./dist;tsc;node dist/src/index.js

I'll probably shorten it some way or another

[jovial kernel]

no you do tsc watch

[vague dew]

What does that do?

[paper spoke]

I've always wondered

With ts

How do you make like, a new class or something for Events

So you can do something like (probs bad ts all together thouggh 💀)

export new Event('interactionCreate) {}

type of thing

[jovial kernel]

remember all js code is valid ts

[vague dew]

And all ts code is valid js ||when compiled||

[paper spoke]

yh but i actually dk how to do that type of thing with js 💀

i just think it looks neat

So you can do something like (probs bad ts all together thouggh 💀)

export new Event('interactionCreate', async (some params) => { 
    //code
}) 

[vague dew]

What the hell is export new Event

Where did default go, lol

[paper spoke]

missed default

[vague dew]

Alright

[vague dew]

constructor(eventName: string, callback: Function)

[knotty urchin]

Dont need default if theres more than 1 thing in the module tho if i recall that correctly

[vague dew]

I do it for safety ngl

[jovial kernel]

u need to give it a name

[paper spoke]

Thanks for helping people 🙏