andywer / andywer/threads.js

Docs/Enhancement: OOB Example doesn't work. Master.js and Auth.js

Open
#375 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
3.5k
Forks
173
PR merge metrics
No merged PRs in 30d

Description

It seems like the example code assumes a user is using ES/CJS modules...most NPM packages use the standards const ... = require(package) syntax and dont assume someone is working in the module context

Found it kinda confusing that "master.js" is not using require and auth.js isn't referred to as ".mjs". Is this intentional? because this the quick start doesn't work OOB.

Quick start should be
1. npm install threads
2. add {type: module} to your package.json since master and auth assume their app embeds it as a ES module and not a typical nodejs package

Thoughts?

Great work btw!

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.