this post was submitted on 20 Aug 2023
4 points (100.0% liked)

Transprogrammer

823 readers
1 users here now

A space for trans people who code

Matrix Space:

Rules:

founded 1 year ago
MODERATORS
[email protected]
4
How exactly should I structure by NodeJS typescript project (pricefield.org)
submitted 1 year ago by [email protected] to c/[email protected]
3 comments fedilink hide all child comments
 

I am currently working on a silly little project that will post pet's up for adoption every hour to mastodon. I am struggling with how I should structure the project.

Should I put every single step in it's own typescript module, like the main file calls the petgrabber function in petgrabber.ts after 1hr, than petgrabber calls the mastodon function in the mastodon.ts file, or should I just do a single file, or is there a way I am not thinking of. My biggest thing is them being interdependent on each other feels like it defeats the purpose of having them in their own file.

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 3 points 1 year ago

Compartmentalize things so they all handle one thing individually and then you call those things from a main class is generally the way you’d do it.

Splitting things up will make your classes specific to a certain functionality and allow you to keep track of everything without individual files being thousands of lines, though sometimes they will end up that way anyway to achieve a single piece of functionality.

So for example you might have a service to call the api to get data, a service that exclusively posts to mastodon, etc.

You can write 500 lines of code to do something in your service and hide it away but then just call it like petInfoService.getPetInfo() from your main class and when you look at the flow it’ll make a lot more sense.

Any reason you chose typescript out of curiosity? Nothing wrong with it, just curious.

Feel free to post code if you need help. Just make sure whatever you’re posting or uploading to git doesn’t include any API keys.