Add FormData read & edit functions, write documentation #14
Conversation
There was a problem hiding this comment.
This is really nice, thank you!
While the README text is great it's not in-keeping with the style of the other core packages' READMEs, and it teaches quite a lot of things that are not specifically this package, like error handling and concurrency. I think this content would be better somewhere else, but I'm not sure exactly where.
src/gleam_fetch_ffi.mjs
Outdated
| export async function getBitsFormData(formData, key) { | ||
| const data = [...formData.getAll(key)] | ||
| const blobs = data | ||
| .filter(value => value instanceof Blob) |
There was a problem hiding this comment.
I think we'd want to support getting the other data as a bit array, similar to how one can read text files as bit arrays with simplifile
There was a problem hiding this comment.
That's an interesting point. I feel like it's not really how we want to use the package, but I could be wrong. In simplifile, you know what you're doing, and you read a file purposely as BitArray. Here, I'm a bit wondering if pushing a value as string, and getting it as BitArray is really consistent? I think unconsciously I would expect string values being read as string values, and vice-versa.
Do you have any opinion on this? In any case, having the modification would be really straightforward.
There was a problem hiding this comment.
Friendly reminder in case you forgot to answer. 💜
There was a problem hiding this comment.
I would not to not filter out that data, to remain consistent with the Gleam convention reading bits is a superset of reading text. e.g. simplifile and the existing text+binary functions in this package.
There was a problem hiding this comment.
Thanks! Code has been modified to return everything from binaries.
Is there any styleguide somewhere for the core packages' README? If I understand correctly, you do prefer that I remove that content and keep a sleek README? I was thinking to build a documentation website for a while (for learning purpose, and for documenting my packages), maybe this could be the first step? |
|
There's no styleguide, but they concisely introduce the package and give any information specifically related to the package, but they do not teach Gleam more widely. An educational website would be great! We're currently looking at making a guides section of the Gleam website, but what the exact scope would be isn't determined yet. |
ghivert
force-pushed
the
feat/form-data/new-functions-documentation
branch
from
b6d883e to
d2cbd5d
Compare
|
I just modified the README to get something more in-line with the current core packages, and I renamed |
|
Up to date! |
|
No problem! Thanks for your patience too! 💜 |
Hi!
FormDatawas lacking some utilities function, and was lacking tests. That PR implements the remaining pieces in the most Gleamy possible way, while staying 100% compatible with JavaScriptFormData, and implement tests for everyFormDatafunction.gleam/fetchwas lacking documentation. That PR write documentation for every function, with examples.READMEwas nice, but was lacking a bit of context, and could feel hard for newcomers. I took the opportunity of that PR to propose a new, improved version of the README. Of course it's subject to rewrite, modification or rejection if it does not suits you. 🙂 Feel free to be brutally honest to get the best README we can do!About the README, I took freedom to write two parts "
gleam_fetchfor JS users" and "gleam_fetchfor Erlang users", becausegleam_fetchimplies you have to think differently about your code (because of promises) if you're coming from Erlang, and it can be a bit different to what you're used to if you're coming from JS.I tried to be friendly, to provide both an explanation and explaining the intentions behind the packages. I hesitated to write it elsewhere, but I think it's typically a place where it will be read, as HTTP requests are a fairly common requirements: having that information directly in the package would help users and not search for another source of information, like cookbook, etc. If you dislike it, or if you dislike this in this README, it can of course be removed or moved elsewhere.