API documentation please (especially for types!)

[dhdaines]

Hi, orama looks considerably better structured and documented than the other JavaScript search engines, but...

Maybe I'm just not, um, searching hard enough, but I can't seem to find any actual API documentation. For starters, what type does create return? It would be important to know in order to pass it to a function and get type-checking. Does everybody just rely on their IDE/editor to tell them these things?

It would be very nice to have a reference document that tells me what all the options are to the functions, what types they return, etc.

[micheleriva]

Hi @dhdaines, I agree with your points. I personally don't like automatically generated docs, but we should definitely put more effort into adding the documentation you mentioned.

We'll work on that and close the issue once is done. Thanks!