mendix / docs

Mendix documentation repository
https://docs.mendix.com
Creative Commons Attribution 4.0 International
137 stars 705 forks source link

nanoflow-commons #5140

Open Chris-Karona opened 1 year ago

Chris-Karona commented 1 year ago

Please use the form below, leaving the prefilled data to help us. Thank you.

Page link: nanoflow-commons

Document link: nanoflow-commons.md

My Issue/Suggestion

The page provides no information about the contents of Nanoflow Commons over and above the names of the items. Whilst some items are pretty self-explanatory, others are not. In particular, I would like to know what are the use cases for the LocalStorage actions. What is the advantage over storing data in the local database? What are the limitations? Are stored objects visible from one Mendix app to another? I'm also interested to know about the GenerateUniqueId function - how "unique" is it - fairly unique, very unique or universally unique? The documentaion tab says, "Generates a unique ID based on the current session." What does "based on" mean? It seems to include the SessionId as part of the id but are session ids unique over time?

ConnorLand commented 8 months ago

Hello @Chris-Karona ,

Apologies for the late reply. Updating Nanoflow Commons with more details has been on our task list for a little while. I showed this feedback to the developers and they are going to work with me to add descriptions for all the actions.

It should be done in the near future. I will update you when the document has more information.

Thanks for reaching out to Documentation,

Connor

ConnorLand commented 8 months ago

Also, the developer wanted me to share the Nanoflow Commons repo with you. Specifically, you can learn more about how local storage and generate unique ID are implemented:

https://github.com/mendix/nanoflow-commons/tree/main/src/local-storage

https://github.com/mendix/nanoflow-commons/blob/main/src/other/GenerateUniqueID.ts