Docs: Added jsDoc

[jankapunkt]

Summary

Adds jsDoc to build and code

Linked issue(s)

partially #141 in order to improve documentation for better logging

Involved parts of the project

• build
• all code
• Readme
• docs

Added tests?

no extra tests

Targeted Meteor release version

Reproduction

clone repo, checkout docs/jsdoc and run npm run build:docs

[jankapunkt]

published a release 2.8.0-rc.1 for testing this PR

[bratelefant]

I do some testing with 2.8.0-rc.1.

[bratelefant]

Got a little trouble building with expo, because I also import @meteorrn/local and the depencency with 2.8.0-rc.1 is not accepted. Can I override (--force?) this in eas-cli?

[jankapunkt]

Is there a specific error?

[bratelefant]

If I do npm install @meteorrn/local@2.8.0-rc.1 I end up with No matching version found for @meteorrn/local@2.8.0-rc.1.

[jankapunkt]

You have to npm install @meteorrn/core@2.8.0-rc.1 , it's published to NPM so you don't need a local version.

Edit: since it's tagged as next on npm it's only installed if you explicitly set the version and the defualt on NPM still points to 2.7.1

[bratelefant]

I get @meteorrn/core@2.8.0-rc.1 installed, but while building with eas-cli I get

Could not resolve dependency:
[INSTALL_DEPENDENCIES] npm ERR! peer @meteorrn/core@">=2.0.7" from @meteorrn/local@1.0.3
[INSTALL_DEPENDENCIES] npm ERR! node_modules/@meteorrn/local
[INSTALL_DEPENDENCIES] npm ERR!   @meteorrn/local@"^1.0.3" from the root project

because I also have @meteorrn/local@1.0.3 in my package.json. Is @meteorrn/core@">=2.0.7 not fulfilled?

[jankapunkt]

ah I see, this is a peer dependency conflict, let me check, if I can resolve this quickly

[bratelefant]

Can we simply add a >= 2.0.7 || 2.8.0-rc.1 or something as a peer dep for meteorrn/local?

[bratelefant]

Could build it with the added peerDep

[bratelefant]

Docs are great, maybe at some point we could add a git workflow to auto-generate docs and deploy on github pages

[bratelefant]

I'd like to report that removing NetInfo in my staging environment seems to solve a problem that occurred randomly and is still hard to reproduce.

Namely, on iOS, when bringing the app back up from (suspended) background, the user did not log back in, although the socket was connected.

Now I manage connection / disconnecting via rn AppState, look good so far.

[jankapunkt]

Great! We should add that to the docs, like a troubleshooting section. Something like "if you have trouble with reconnecting,.try Appstate instead of NetInfo. Here is a minimal example:...". Do you have the time and will to add this section to this PR?

[jankapunkt]

@bratelefant we will add Troubleshooting / FAQ in another PR, would you mind adding a review in the meantime?

[bratelefant]

Sorry, forgot to approve. Changes reviewed and looking good.

[bratelefant]

We can merge this, will add my AppState example in another PR

[jankapunkt]

Thanks 👍