search

i18next / i18next-http-middleware

i18next-http-middleware is a middleware to be used with Node.js web frameworks like express or Fastify and also for Deno.
MIT License
152 stars 28 forks source link

Undocumented options for most methods #57

Closed lukaromih closed 1 year ago

lukaromih commented 1 year ago

Documentation issue

Most middlewares/plugins in this module have undocumented options and are also not part of any example. Would it be possible to document all available options for those (e.g. for handle method) in the sense that Detector Options are documented.

Motivation

I've read some articles regarding the use of i18next and different parts of its ecosystem after I've already integrated it successfully into my project. I've rolled my own language switch functionality, but multiple articles mentioned a relatively simple switch without any extra endpoints, simply using a lng query param on the current page. I didn't like the idea of those aditional query params in URL. One of the articles mentioned the removeLngFromUrl option however. I've searched for it throughout this module's readme and its examples. Only after a quick glance at source code did it show up. It would really help to know what other options are available on all the offered middlewares/plugins and what they do. Apart from that, hats of for a very well maintained and documented ecosystem.

adrai commented 1 year ago

The removeLngFromUrl option was originally introduced in i18next-express-middleware (I completely missed that option). I've found also 2 other options... and added a minimal info in the readme

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.