Profile picture
Sindre Sorhus 🇳🇴 @sindresorhus
, 7 tweets, 2 min read Read on Twitter
Node.js' insistence on being familiar to Unix people has hurt its developer experience more than they realize. Even after this many years, the docs are still subpar. Docs for `fs.mkdir` only says: `Asynchronous mkdir(2)` You shouldn't have to be Unix graybeard to use Node.js.
`mkdir(2)` does link to the Linux kernel man pages, but you shouldn't have to read Linux kernel docs to use Node.js.
When Apple has better API docs something is seriously wrong: developer.apple.com/documentation/… And a more intuitive method name.
So much resistance to improve the behavior and docs too:
github.com/nodejs/node/is…
github.com/nodejs/node/is…
github.com/nodejs/node/is…
If I had time, I would create a user-friendly API layer upon Node.js core. For example: `fs.createDirectory()` instead of `fs.mkdir()`, with great docs, examples, best practices, etc. The Node.js APIs are good, they're just too low-level and not dev friendly for common use.
I would be more than happy to help out improve the docs if I don't have to fight for every little docs improvement.
Even Rust, which is a low-level systems language, has more user-friendly API docs and method names. Example: doc.rust-lang.org/std/fs/fn.crea…
Missing some Tweet in this thread?
You can try to force a refresh.

Like this thread? Get email updates or save it to PDF!

Subscribe to Sindre Sorhus 🇳🇴
Profile picture

Get real-time email alerts when new unrolls are available from this author!

This content may be removed anytime!

Twitter may remove this content at anytime, convert it as a PDF, save and print for later use!

Try unrolling a thread yourself!

how to unroll video

1) Follow Thread Reader App on Twitter so you can easily mention us!

2) Go to a Twitter thread (series of Tweets by the same owner) and mention us with a keyword "unroll" @threadreaderapp unroll

You can practice here first or read more on our help page!

Did Thread Reader help you today?

Support us! We are indie developers!


This site is made by just three indie developers on a laptop doing marketing, support and development! Read more about the story.

Become a Premium Member and get exclusive features!

Premium member ($3.00/month or $30.00/year)

Too expensive? Make a small donation by buying us coffee ($5) or help with server cost ($10)

Donate via Paypal Become our Patreon

Thank you for your support!