Please provide better documentation #27

Activity

1. diegomvh commented on Apr 16, 2021

   

   diegomvh

   on Apr 16, 2021

   Last edited by diegomvh

   Owner

   More actions

   Hi @PhilippRoessner

   Basically, the library works with abstractions of the odata endpoints called resources.
   There are different types of resources (entity-set, entity, property, etc) and they are obtained from services.
   Each resource according to its type has different ways of interacting with it using the http get post put delete methods.
   For these http primitives the library only takes the data and the associated metadata and makes it available to the caller
   Then with these primitives higher order functions such as fetch, fetchAll or call are built, depending on the need

   Documentation is a big missing and a "skinny" part of the project.
   Regarding the use, there is an example project.

   https://github.com/diegomvh/AngularODataEntity/blob/1ce092b9421e0033ca761ead4efd47df3d3fc195/src/app/app.component.ts#L74

   The demo does not cover all the functionality but it does cover the basics.
   My intention is to continue adding and working on the features. Although eventually documenting will be necessary.

   Regards
2. AliAlmutawakel commented on May 20, 2021

   

   AliAlmutawakel

   on May 20, 2021

   More actions

   Documentation is really necessary for this library. It's great, thorough, and extremely powerful but it's too bad nobody knows how to use it. Even minimum documentation would be super helpful. Nothing fancy is necessary, just a minimal function or property /** documentation */ can go a long way to say what it does. At least then more people would use it, issues can be found, library stabilizes & matures quicker, and opens doors for people to contribute to it. I hope you would change your mind about the priority of the documentation or at least cover all the functionality in the example project.

   👍React with 👍2Reacted by Diego van Haaster and Shanzhi Chen
3. Coder7777 commented on Jun 2, 2021

   

   Coder7777

   on Jun 2, 2021

   More actions

   Documentation is really necessary for this library. It's great, thorough, and extremely powerful but it's too bad nobody knows how to use it. Even minimum documentation would be super helpful. Nothing fancy is necessary, just a minimal function or property /** documentation */ can go a long way to say what it does. At least then more people would use it, issues can be found, library stabilizes & matures quicker, and opens doors for people to contribute to it. I hope you would change your mind about the priority of the documentation or at least cover all the functionality in the example project.

   I can not agree with you more.

   👍React with 👍1Reacted by Diego van Haaster
4. krstev1994 commented on Jun 22, 2021

   

   krstev1994

   on Jun 22, 2021

   More actions

   Hi Diego,
   Can you provide some examples of using create, update and destroy methods?
   Get and fetch options are awesome!
   Tnx and BR,
   Vasil.

   👍React with 👍1Reacted by Dávid Egresits