New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ Meteor 3 ] - API Docs #12926
[ Meteor 3 ] - API Docs #12926
Conversation
just a quick update, guys: **: Forgot I need to setup algolia as well |
This is the new docs that we said that we are working on.
This includes the revision of our API docs and a site for guiding current meteor users to the 3.0 version.
For a preview you can check here
Checklist:
API:
Packages:
Pages that need to be updated:
WebApp
Some methods are now async
Changed engine from connect to express and changed API naming to match express. It needs to be documented as well.
server-render
getBoilerplate
is now asyncordered-dict
Added
forEachAsync
methodoauth
Private methods are now async. This might affect end user
1 -
OAuth._storeRequestToken
andOAuth._retrieveRequestToken
are async(maybe we need to review docs on how to use oauth12 OAuth._requestHandlers['2']` is now async
MongoDB
Minimongo
cursor.observe
now returnsisReady
andisReadyPromise
wich indicates if the cursor is ready and if the callbacks are have been calledIf you only use it in the
Client
or as aLocalCollection
things have not changedMinifiers
Minifiers are now async,
HTTP
Email
Email.send
is no longer available. Use `Email.sendAsync` instead. needs to be updated in the docs as wellUpdated types to reflext async methods and `Email.send` depracation.
Maybe we should be able to use both but it needs to be explained that send and sendAsync are the same
Meteor
Check changes to
Meteor
global and update docsBrowser policy content
some methods are now async
DDP
Document
.fence
optionDocument
isAsyncCall
method