${injectedContent}`);
+});
\ No newline at end of file
diff --git a/docs/source/api/accounts-multi.md b/docs/source/api/accounts-multi.md
index f4c92218f4..a008b7d807 100644
--- a/docs/source/api/accounts-multi.md
+++ b/docs/source/api/accounts-multi.md
@@ -151,7 +151,8 @@ password-based users or from an external service login flow. `options` may come
from an untrusted client so make sure to validate any values you read from
it. The `user` argument is created on the server and contains a
proposed user object with all the automatically generated fields
-required for the user to log in, including the `_id`.
+required for the user to log in, including a temporary `_id` (the final _id is
+generated upon document insertion and not available in this function).
The function should return the user document (either the one passed in or a
newly-created object) with whatever modifications are desired. The returned
@@ -297,7 +298,7 @@ The function will be called with a single argument, the info object:
{% enddtdd %}
{% dtdd name:"options" type:"Exception" %}
- An optional arugment passed down from the oauth service that may contain
+ An optional argument passed down from the oauth service that may contain
additional user profile information. As the data in `options` comes from an
external source, make sure you validate any values you read from it.
{% enddtdd %}
diff --git a/docs/source/api/accounts.md b/docs/source/api/accounts.md
index cf0cb7205a..f9429426e7 100644
--- a/docs/source/api/accounts.md
+++ b/docs/source/api/accounts.md
@@ -19,6 +19,24 @@ login provider packages: `accounts-password`, `accounts-facebook`,
Read more about customizing user accounts in the [Accounts](http://guide.meteor.com/accounts.html) article in the Meteor Guide.
+
Accounts with Session Storage
+
+By default, Meteor uses Local Storage to store, among other things, login tokens in your browser session. But, for some applications, it makes sense to use Session Storage instead. You can achieve this by adding this to your settings:
+
+```json
+{
+ // ... all other settings,
+ "public": {
+ // ... all your public settings
+ "packages": {
+ "accounts": {
+ "clientStorage": "session"
+ }
+ }
+ }
+}
+```
+
{% apibox "Meteor.user" %}
Retrieves the user record for the current user from
@@ -338,3 +356,41 @@ Accounts.ui.config({
Since Meteor 2.7 you can configure these in your Meteor settings under `Meteor.settings.public.packages.accounts-ui-unstyled`.
+
+
Initialize with custom settings
+
+This feature allows users to specify custom configuration parameters for both client-side and server-side initialization.
+
+* Client
+
+{% apibox "AccountsClient" %}
+
+On the client-side, AccountsClient can be initialized with custom parameters provided through Meteor settings configuration. Below is an example of how to use this functionality:
+
+```json
+{
+ "public": {
+ "packages": {
+ "accounts": {
+ ...configParams
+ }
+ }
+ }
+}
+```
+
+* Server
+
+{% apibox "AccountsServer" %}
+
+On the server-side, AccountsServer can also be initialized with custom parameters. Server-specific configuration may differ from the client and can also be specified through Meteor settings. Below is an example of how to do it:
+
+```json
+{
+ "packages": {
+ "accounts": {
+ ...configParams
+ }
+ }
+}
+```
diff --git a/docs/source/api/assets.md b/docs/source/api/assets.md
index e748b5b49d..af4cd86124 100644
--- a/docs/source/api/assets.md
+++ b/docs/source/api/assets.md
@@ -10,8 +10,8 @@ assets, which are located in the `private` subdirectory of an application's
tree. Assets are not processed as source files and are copied directly
into your application's bundle.
-{% apibox "Assets.getText" %}
-{% apibox "Assets.getBinary" %}
+{% apibox "Assets.getTextAsync" %}
+{% apibox "Assets.getBinaryAsync" %}
{% apibox "Assets.absoluteFilePath" %}
Static server assets are included by placing them in the application's `private`
@@ -20,7 +20,7 @@ directory called `nested` with a file called `data.txt` inside it, then server
code can read `data.txt` by running:
```js
-const data = Assets.getText('nested/data.txt');
+const data = await Assets.getTextAsync('nested/data.txt');
```
Note: Packages can only access their own assets. If you need to read the assets of a different package, or of the enclosing app, you need to get a reference to that package's `Assets` object.
diff --git a/docs/source/api/check.md b/docs/source/api/check.md
index 7ecdcae7d8..107c3c865d 100644
--- a/docs/source/api/check.md
+++ b/docs/source/api/check.md
@@ -1,6 +1,6 @@
---
title: Check
-desription: Documentation on how to use check, Meteor's type checking library.
+description: Documentation on how to use check, Meteor's type checking library.
---
The `check` package includes pattern checking functions useful for checking the types and structure
@@ -46,6 +46,11 @@ this error gets sent over the wire to the client, it will appear only as
`Meteor.Error(400, 'Match Failed')`. The failure details will be written to the
server logs but not revealed to the client.
+By default, `check` will throw immediately at the first error encountered. Pass in `{ throwAllErrors: true }` to throw an array of all errors. For example:
+```js
+check(message, {/* ... */}, {throwAllErrors: true})
+```
+
{% apibox "Match.test" %}
`Match.test` can be used to identify if a variable has a certain structure.
diff --git a/docs/source/api/collections.md b/docs/source/api/collections.md
index dfd14b8d18..355686e820 100644
--- a/docs/source/api/collections.md
+++ b/docs/source/api/collections.md
@@ -201,10 +201,10 @@ changes the documents in a cursor will trigger a recomputation. To
disable this behavior, pass `{reactive: false}` as an option to
`find`.
-Note that when `fields` are specified, only changes to the included
+Note that when `projection` are specified, only changes to the included
fields will trigger callbacks in `observe`, `observeChanges` and
invalidations in reactive computations using this cursor. Careful use
-of `fields` allows for more fine-grained reactivity for computations
+of `projection` allows for more fine-grained reactivity for computations
that don't depend on an entire document.
On the client, there will be a period of time between when the page loads and
@@ -216,6 +216,8 @@ collections will be empty.
Equivalent to [`find`](#find)`(selector, options).`[`fetch`](#fetch)`()[0]` with
`options.limit = 1`.
+> **Note**: The `fields` option is deprecated in favor of `projection`, which aligns with MongoDB's official terminology and driver. Using `projection` ensures consistency and clarity in specifying which fields to include or exclude in query results.
+
{% apibox "Mongo.Collection#findOneAsync" %}
Async version of [`findOne`](#findOne) that return a `Promise`.
@@ -837,6 +839,7 @@ const handle = cursor.observeChanges({
setTimeout(() => handle.stop(), 5000);
```
+{% apibox "Mongo.getCollection" %}
{% apibox "Mongo.ObjectID" %}
`Mongo.ObjectID` follows the same API as the [Node MongoDB driver
@@ -949,30 +952,30 @@ document objects, and returns -1 if the first document comes first in order,
1 if the second document comes first, or 0 if neither document comes before
the other. This is a Minimongo extension to MongoDB.
-
Field Specifiers
+
Projection Specifiers
Queries can specify a particular set of fields to include or exclude from the
-result object.
+result object using the `projection` option.
-To exclude specific fields from the result objects, the field specifier is a
+To exclude specific fields from the result objects, the projection specifier is a
dictionary whose keys are field names and whose values are `0`. All unspecified
fields are included.
```js
-Users.find({}, { fields: { password: 0, hash: 0 } });
+Users.find({}, { projection: { password: 0, hash: 0 } });
```
To include only specific fields in the result documents, use `1` as
the value. The `_id` field is still included in the result.
```js
-Users.find({}, { fields: { firstname: 1, lastname: 1 } });
+Users.find({}, { projection: { firstname: 1, lastname: 1 } });
```
With one exception, it is not possible to mix inclusion and exclusion styles:
the keys must either be all 1 or all 0. The exception is that you may specify
`_id: 0` in an inclusion specifier, which will leave `_id` out of the result
-object as well. However, such field specifiers can not be used with
+object as well. However, such projection specifiers can not be used with
[`observeChanges`](#observe_changes), [`observe`](#observe), cursors returned
from a [publish function](#meteor_publish), or cursors used in
`{% raw %}{{#each}}{% endraw %}` in a template. They may be used with [`fetch`](#fetch),
@@ -993,10 +996,12 @@ Users.insert({
name: 'Yagami Light',
});
-Users.findOne({}, { fields: { 'alterEgos.name': 1, _id: 0 } });
+Users.findOne({}, { projection: { 'alterEgos.name': 1, _id: 0 } });
// Returns { alterEgos: [{ name: 'Kira' }, { name: 'L' }] }
```
+> Note: The `fields` option is deprecated in favor of `projection`, which is the standard term used by MongoDB. Using `projection` ensures compatibility with MongoDB's documentation and drivers.
+
See
the MongoDB docs for details of the nested field rules and array behavior.
@@ -1082,6 +1087,38 @@ option:
You can pass any MongoDB valid option, these are just examples using
certificates configurations.
+
Mongo Oplog Options
+
+> Oplog options were introduced in Meteor 2.15.1
+
+If you set the [`MONGO_OPLOG_URL`](https://docs.meteor.com/environment-variables.html#MONGO-OPLOG-URL) env var, Meteor will use MongoDB's Oplog to show efficient, real time updates to your users via your subscriptions.
+
+Due to how Meteor's Oplog implementation is built behind the scenes, if you have certain collections where you expect **big amounts of write operations**, this might lead to **big CPU spikes on your meteor app server, even if you have no publications/subscriptions on any data/documents of these collections**. For more information on this, please have a look into [this blog post from 2016](https://blog.meteor.com/tuning-meteor-mongo-livedata-for-scalability-13fe9deb8908), [this github discussion from 2022](https://github.com/meteor/meteor/discussions/11842) or [this meteor forums post from 2023](https://forums.meteor.com/t/cpu-spikes-due-to-oplog-updates-without-subscriptions/60028).
+
+To solve this, **2 Oplog settings** have been introduced **to tweak, which collections are *watched* or *ignored* in the oplog**.
+
+**Exclusion**: To *exclude* for example all updates/inserts of documents in the 2 collections called `products` and `prices`, you would need to set the following setting in your Meteor settings file:
+
+```json
+ "packages": {
+ "mongo": {
+ "oplogExcludeCollections": ["products", "prices"]
+ }
+ }
+```
+
+**Inclusion**: vice versa, if you only want to watch/*include* the oplog for changes on documents in the 2 collections `chats` and `messages`, you would use:
+
+```json
+ "packages": {
+ "mongo": {
+ "oplogIncludeCollections": ["chats", "messages"]
+ }
+ }
+```
+
+For obvious reasons, using both `oplogExcludeCollections` and `oplogIncludeCollections` at the same time is not possible and will result in an error.
+
Mongo.setConnectionOptions
You can also call `Mongo.setConnectionOptions` to set the connection options but
diff --git a/docs/source/api/core.md b/docs/source/api/core.md
index 8909e93256..7edd43c60f 100644
--- a/docs/source/api/core.md
+++ b/docs/source/api/core.md
@@ -3,7 +3,7 @@ title: Core
description: Documentation of core Meteor functions.
---
-If you prefer to watch the video, click below.
+If you prefer to watch the video, click below.
{% youtube 6RRVU0-Vvm8 %}
@@ -64,3 +64,5 @@ if (Meteor.isServer) {
{% apibox "Meteor.isAppTest" %}
{% apibox "Meteor.isPackageTest" %}
+
+{% apibox "Meteor.isFibersDisabled" %}
diff --git a/docs/source/api/methods.md b/docs/source/api/methods.md
index 03854c603d..a476e9dbc6 100644
--- a/docs/source/api/methods.md
+++ b/docs/source/api/methods.md
@@ -80,6 +80,12 @@ with this ID has already been made. Alternatively, you can use
Read more about methods and how to use them in the [Methods](http://guide.meteor.com/methods.html) article in the Meteor Guide.
+{% apibox "Meteor.isAsyncCall" %}
+
+This method can be used to determine if the current method invocation is
+asynchronous. It returns true if the method is running on the server and came from
+an async call(`Meteor.callAsync`)
+
{% apibox "DDPCommon.MethodInvocation#userId" %}
The user id is an arbitrary string — typically the id of the user record
diff --git a/docs/source/api/mobile-config.md b/docs/source/api/mobile-config.md
index c32b33791a..c5202b57d7 100644
--- a/docs/source/api/mobile-config.md
+++ b/docs/source/api/mobile-config.md
@@ -54,16 +54,7 @@ App.launchScreens({
'Default@2x~ipad~comany': 'Default@2xipadcomany.png', // (1278x2732) - iPad Pro 12.9"/11"/10.5"/9.7"/7.9" - portrait mode
// Android
- 'android_mdpi_portrait': 'splash/android_mdpi_portrait.png', // (320x480)
- 'android_mdpi_landscape': { src: 'splash/android_mdpi_landscape.png', srcDarkMode: 'splash/android_mdpi_landscape-night.png' }, // (480x320)
- 'android_hdpi_portrait': 'splash/android_hdpi_portrait.png', // (480x800)
- 'android_hdpi_landscape': 'splash/android_hdpi_landscape.png', // (800x480)
- 'android_xhdpi_portrait': 'splash/android_xhdpi_portrait.png', // (720x1280)
- 'android_xhdpi_landscape': 'splash/android_xhdpi_landscape.png', // (1280x720)
- 'android_xxhdpi_portrait': { src: 'splash/android_xxhdpi_portrait.png', srcDarkMode: 'splash/android_xxhdpi_portrait-night.png'}, // (960x1600)
- 'android_xxhdpi_landscape': 'splash/android_xxhdpi_landscape.png', // (1600x960)
- 'android_xxxhdpi_portrait': 'splash/android_xxxhdpi_portrait.png', // (1280x1920)
- 'android_xxxhdpi_landscape': 'splash/android_xxxhdpi_landscape.png', // (1920x1280)
+ 'android_universal': 'splash/android_universal.png', // (320x480)
});
// Set PhoneGap/Cordova preferences.
diff --git a/docs/source/api/packagejs.md b/docs/source/api/packagejs.md
index 7cc521073f..9feb02877f 100644
--- a/docs/source/api/packagejs.md
+++ b/docs/source/api/packagejs.md
@@ -80,7 +80,7 @@ package) so that Meteor will pick up the local dependency.
> In a lifecycle of a package there might come time to end the development for various reasons, or
it gets superseded. In either case Meteor allows you to easily notify the users of the package by
setting the deprecated flag to true: `deprecated: true` in the package description. In addition, you
-replace it with a string that tells the users where to find replacement or what to do.
+replace it with a string that tells the users where to find replacement or what to do.
Provide basic package information with `Package.describe(options)`. To publish a
package, you must define `summary` and `version`.
@@ -97,7 +97,7 @@ package is exported to.
{% apibox "PackageAPI#versionsFrom" %}
> Choose Meteor versions carefully. First determine the minimum version of Meteor you need for the API you use in your package.
- This should be based on specific needs of your package like needed the *Async calls, which would require minimum version to be
+ This should be based on specific needs of your package like needed the *Async calls, which would require minimum version to be
at least 2.8. Another example are where packages had a major version bump, for example this has happened with the accounts packages
in Meteor 2.3. If you want to be backward and forward compatible it is good to include Meteor version before 2.3 and then 2.3.6 in the array.
A general recommendation for most compatibility for accounts packages (unless you need API that was affected in Meteor 2.3) is to have the following
@@ -315,7 +315,7 @@ methods are available:
- `addAsset` - Add a file to serve as-is to the browser or to include on the
browser, depending on the target. On the web, it will be served at the exact
path requested. For server targets, it can be retrieved using
- `Assets.getText` or `Assets.getBinary`.
+ `Assets.getTextAsync` or `Assets.getBinaryAsync`.
- `addHtml` - Works in web targets only. Add markup to the `head` or `body`
section of the document.
- `hmrAvailable` - Returns true if the file can be updated with HMR. Among other things,
diff --git a/docs/source/api/passwords.md b/docs/source/api/passwords.md
index a1967e174e..908617aa3e 100644
--- a/docs/source/api/passwords.md
+++ b/docs/source/api/passwords.md
@@ -27,13 +27,17 @@ include a turn-key user interface for password-based sign-in.
{% apibox "Accounts.createUser" %}
+Or a promise based version of `Accounts.createUser`:
+
+{% apibox "Accounts.createUserAsync" %}
+
On the client, this function logs in as the newly created user on
successful completion. On the server, it returns the newly created user
id.
On the client, you must pass `password` and at least one of `username` or `email` — enough information for the user to be able to log in again later. If there are existing users with a username or email only differing in case, `createUser` will fail. The callback's `error.reason` will be `'Username already exists.'` or `'Email already exists.'` In the latter case, the user can then either [login](accounts.html#Meteor-loginWithPassword) or [reset their password](#Accounts-resetPassword).
-On the server, you do not need to specify `password`, but the user will not be able to log in until it has a password (eg, set with [`Accounts.setPassword`](#accounts_setpassword)). To create an account without a password on the server and still let the user pick their own password, call `createUser` with the `email` option and then call [`Accounts.sendEnrollmentEmail`](#accounts_sendenrollmentemail). This will send the user an email with a link to set their initial password.
+On the server, you do not need to specify `password`, but the user will not be able to log in until it has a password (eg, set with [`Accounts.setPasswordAsync`](#accounts_setpasswordasync)). To create an account without a password on the server and still let the user pick their own password, call `createUser` with the `email` option and then call [`Accounts.sendEnrollmentEmail`](#accounts_sendenrollmentemail). This will send the user an email with a link to set their initial password.
By default the `profile` option is added directly to the new user document. To
override this behavior, use [`Accounts.onCreateUser`](#accounts_oncreateuser).
@@ -49,18 +53,20 @@ insensitive duplicates before updates.
{% apibox "Accounts.setUsername" %}
-{% apibox "Accounts.addEmail" %}
+{% apibox "Accounts.addEmailAsync" %}
By default, an email address is added with `{ verified: false }`. Use
[`Accounts.sendVerificationEmail`](#Accounts-sendVerificationEmail) to send an
email with a link the user can use to verify their email address.
+{% apibox "Accounts.replaceEmailAsync" %}
+
{% apibox "Accounts.removeEmail" %}
{% apibox "Accounts.verifyEmail" %}
If the user trying to verify the email has 2FA enabled, this error will be thrown:
-* "Email verified, but user not logged in because 2FA is enabled [2fa-enabled]": No longer signing in the user automatically if the user has 2FA enabled.
+* "Email verified, but user not logged in because 2FA is enabled [2fa-enabled]": No longer signing in the user automatically if the user has 2FA enabled.
This function accepts tokens passed into the callback registered with
@@ -96,7 +102,7 @@ This function accepts tokens passed into the callbacks registered with
If the user trying to reset the password has 2FA enabled, this error will be thrown:
* "Changed password, but user not logged in because 2FA is enabled [2fa-enabled]": No longer signing in the user automatically if the user has 2FA enabled.
-{% apibox "Accounts.setPassword" %}
+{% apibox "Accounts.setPasswordAsync" %}
{% apibox "Accounts.sendResetPasswordEmail" %}
diff --git a/docs/source/api/pubsub.md b/docs/source/api/pubsub.md
index 76f1343952..6420455723 100644
--- a/docs/source/api/pubsub.md
+++ b/docs/source/api/pubsub.md
@@ -268,7 +268,7 @@ stay subscribed to your private messages.
> The following features are available from Meteor 2.4 or `ddp-server@2.5.0`
Once you start scaling your application you might want to have more control on how the data from publications is being handled on the client.
-There are three publications strategies:
+There are four publications strategies:
#### SERVER_MERGE
`SERVER_MERGE` is the default strategy. When using this strategy, the server maintains a copy of all data a connection is subscribed to.
@@ -291,12 +291,17 @@ Specifically:
* When we receive a change message for a document that is not in the client's collection, it will be added.
* When we receive a removed message for a document that is not in the client's collection, nothing will happen.
+#### NO_MERGE_MULTI
+`NO_MERGE_MULTI` is similar to `NO_MERGE`, but it does track whether a document is used by multiple publications.
+This has some memory overhead, but it still does not do diffing so it's faster and slimmer than
+`SERVER_MERGE`.
+
You can import the publication strategies from `DDPServer`.
```js
import { DDPServer } from 'meteor/ddp-server'
-const { SERVER_MERGE, NO_MERGE_NO_HISTORY, NO_MERGE } = DDPServer.publicationStrategies
+const { SERVER_MERGE, NO_MERGE_NO_HISTORY, NO_MERGE, NO_MERGE_MULTI } = DDPServer.publicationStrategies
```
You can use the following methods to set or get the publication strategy for publications:
diff --git a/docs/source/api/top-level-await.md b/docs/source/api/top-level-await.md
new file mode 100644
index 0000000000..accc3f84d7
--- /dev/null
+++ b/docs/source/api/top-level-await.md
@@ -0,0 +1,122 @@
+---
+title: Top Level Await
+description: Documentation of how to use top level await in Meteor
+---
+
+[Top level await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await#top_level_await) (TLA) allows you to use `await` in the top level of a module or file instead of only in async functions. One way to view it as every file runs inside an `async` function.
+
+Here is an example of using top level await on the server. When this file is loaded, the `await` will cause the module to wait for the count before the code in the rest of the module is run.
+
+```js
+const Links = new Mongo.Collection('links');
+
+// Async code using top level await.
+// The module waits for this to finish before continuing
+const count = await Links.find().countAsync();
+
+if (count === 0) {
+ await Links.insertAsync({ url: 'https://meteor.com' });
+}
+```
+
+In previous versions of Meteor, async code using fibers could be run in the top level of a module. Top level await allows writing similar code that works without fibers. There are a few differences that this article will cover.
+
+Meteor's implementation of top level await tries to closely follow the specification. There currently are some differences with how Meteor handles circular dependencies.
+
+## Using Top Level Await
+
+Top level await can be used in any app or package that uses the `ecmascript`, `typescript`, or `coffeescript` packages, or that uses any other build plugin that compiles top level await using reify.
+Generally, if you can use ECMAScript modules, then you can also use top level await.
+
+There are some extra considerations when using top level await in packages. They are covered later in this article.
+
+Top level await is only enabled by default on the server. You can enable it for the client by setting the env var `METEOR_ENABLE_CLIENT_TOP_LEVEL_AWAIT` to `true`. There are a couple known issues with using TLA on the client:
+
+1. It breaks any files in `/client/compatibility` since it now wraps those files in a function
+2. Hot module replacement has not been updated to work with TLA
+
+## Async Modules
+
+With top level await, some modules are considered async, which affects how they behave. There are two ways a module can become an async module:
+1. It uses top level await
+2. It imports a module that is async
+
+For example, this module (`setup.js`) would be async because it uses top level await:
+
+```js
+await setupLanguages();
+```
+
+This module (`main.js`) would be sync:
+
+```js
+console.log('in main.js');
+```
+
+However, if it imports `setup.js` which does use top level await, then `main.js` also becomes async.
+
+```js
+import './setup.js';
+
+console.log('in main.js');
+```
+
+## Require
+
+When using `require` to load an async module, instead of directly returning a module's exports, it will return a promise that resolves to the module's exports.
+
+```js
+// resolves to the exports of init.js
+const promise = require('./init.js');
+```
+
+If you are using `require`, this does mean you need to be careful when adding or removing top level await in a file since you also have to update where the module is required.
+Since a module becomes async if it depends on an async module, this could affect more than just the individual modules using top level await.
+
+When possible, you can use ecmascript import syntax or dynamic imports instead so you don't have to worry about which modules are sync or async.
+
+## Nested Imports
+
+Nested imports refer to using `import ...` outside of the root of a module, for example in an if block or a function.
+
+```js
+if (Meteor.isClient) {
+ import './init-client.js';
+}
+
+export function showNotification(message) {
+ import show from './notifications.js';
+
+ show(message);
+}
+```
+
+ This is a feature unique to Meteor, so the top level await specification wasn't written to work with nested imports. Using nested imports to import a sync module continues to work, but it will throw an error if used to import an async module. You can use `require` or dynamic imports for async modules in these situations.
+
+## Using in Packages
+
+Top level await is only supported starting in Meteor 3. Published build plugins are able to use top level await in older Meteor versions since the runtime is bundled when they are published, though in development they require Meteor 3.
+
+If you want to ensure your package only runs in versions of Meteor that support top level await, you can have your package use `isobuild:top-level-await`:
+
+```js
+Package.onUse(function (api) {
+ // Do not allow this package to be used in pre-Meteor 3 apps.
+ api.use("isobuild:top-level-await@3.0.0");
+});
+```
+
+When importing a package that does not have a lazy main module, it will work the same whether a package uses top level await or not. This is true even when using `require`. This allows packages to add or remove top level await without it being a breaking change.
+
+There are a couple cases where adding or removing top level await from a module in a package could be considered a breaking change:
+
+1. If specific modules are require'd from a package. For example: `require('meteor/zodern:aurorae/svelte.js')`. When importing a specific module from a package, `require` changes its behavior based on if the module is async or not.
+2. If a package that has lazy main modules is require'd. Unlike normal packages, `require` will return a promise if the lazy main module is an async module. Changing if the lazy main module is async or not should be considered a breaking change for the package.
+
+## Module and Package Execution Order
+
+Normally, modules are run one at a time. This was even true when using async code with fibers in the root of a module. However, top level await is different - it allows siblings (modules that do not depend on each other) to sometimes run in parallel. This can allow the app to load faster, which is especially important on the client. However, this could cause code to run in an unexpected order if you are used to how Meteor worked with fibers.
+
+This is also applies to packages. Packages that do not directly or indirectly depend on each other are able to load in parallel if they use top level await.
+
+Modules that are eagerly evaluated (added in packages with `api.addFiles`, or outside of `imports` in apps that do not have a main module) and not directly imported continue to run one at a time, even if they use top level await, since it is common for these modules to implicitly depend on the previous modules.
diff --git a/docs/source/api/tracker.md b/docs/source/api/tracker.md
index ee1b7daae3..8701a3d466 100644
--- a/docs/source/api/tracker.md
+++ b/docs/source/api/tracker.md
@@ -80,7 +80,7 @@ If the initial run of an autorun throws an exception, the computation
is automatically stopped and won't be rerun.
### Tracker.autorun and async callbacks
-`Tracker.autorun` can accept an `async` callback function.
+`Tracker.autorun` can accept an `async` callback function.
To preserve reactivity for the reactive variables inside the async callback function, you must use a `Tracker.withComputation`Β call as described below:
{% apibox "Tracker.withComputation" %}
@@ -90,13 +90,13 @@ Tracker.autorun(async function example1(computation) {
// Code before the first await will stay reactive.
reactiveVar1.get(); // This will trigger a rerun.
- let links = await LinksCollection.findAsync({}).fetch(); // First async call will stay reactive.
+ let links = await LinksCollection.find({}).fetchAsync(); // First async call will stay reactive.
// Code after the first await looses Tracker.currentComputation: no reactivity.
reactiveVar2.get(); // This won't trigger a rerun.
-
+
// You can bring back reactivity with the Tracker.withCompuation wrapper:
- let users = await Tracker.withComputation(computation, () => Meteor.users.findAsync({}).fetch());
+ let users = await Tracker.withComputation(computation, () => Meteor.users.find({}).fetchAsync());
// Code below will again not be reactive, so you will need another Tracker.withComputation.
const value = Tracker.withComputation(computation, () => reactiveVar3.get()); // This will trigger a rerun.
@@ -112,7 +112,7 @@ The `react-meteor-data` package uses `Tracker.withComputation` to make the `useT
More can be seen [here](https://github.com/meteor/react-packages/tree/master/packages/react-meteor-data#maintaining-the-reactive-context)
### Using async callbacks in versions of Meteor prior to 2.10
-`Tracker.autorun` can accept an `async` callback function.
+`Tracker.autorun` can accept an `async` callback function.
However, the async call back function will only be dependent on reactive functions called prior to any called functions that return a promise.
Example 1 - autorun `example1()` **is not** dependent on reactive changes to the `Meteor.users` collection. Because it is dependent on nothing reactive it will run only once:
@@ -302,6 +302,41 @@ recomputed at flush time.
This property is a convenience to support the common pattern where a
computation has logic specific to the first run.
+{% apibox "Tracker.Computation#firstRunPromise" %}
+
+`Computation.firstRunPromise` will be set to the result of the call of the autorun function after the initial computation has been completed. If the autorun function is an async function, it'll then contain its promise, thus making the completion of the execution await-able. That allows us to manually synchronize autoruns like this:
+
+```js
+
+await Tracker.autorun(async () => {
+ await Meteor.userAsync();
+ (...more async code...)
+}).firstRunPromise;
+
+await Tracker.autorun(async () => {
+ await asyncSomeOrOther();
+ (...more async code...)
+}).firstRunPromise;
+
+```
+
+For a better developer experience `firstRunPromise` is automatically appended to your async `autorun` calls so you don't have to write them yourself. Meaning this also works:
+
+```js
+
+await Tracker.autorun(async () => {
+ await Meteor.userAsync();
+ (...more async code...)
+});
+
+await Tracker.autorun(async () => {
+ await asyncSomeOrOther();
+ (...more async code...)
+});
+
+```
+
+
Tracker.Dependency
A Dependency represents an atomic unit of reactive data that a
diff --git a/docs/source/commandline.md b/docs/source/commandline.md
index 10a36a8daf..e1494f5a7c 100644
--- a/docs/source/commandline.md
+++ b/docs/source/commandline.md
@@ -33,7 +33,7 @@ required.
This is the default command. Simply running `meteor` is the
same as `meteor run`.
-To pass additional options to Node.js use the `SERVER_NODE_OPTIONS` environment variable. E.g. for Windows PowerShell:
+To pass additional options to Node.js use the `SERVER_NODE_OPTIONS` environment variable. E.g. for Windows PowerShell:
`$env:SERVER_NODE_OPTIONS = '--inspect' | meteor run`. Or for Linux: `SERVER_NODE_OPTIONS=--inspect-brk meteor run`.
To specify a port to listen on (instead of the default 3000), use `--port [PORT]`.
@@ -43,6 +43,9 @@ For example: `meteor run --port 4000`
will run the development server on `http://localhost:4000`
and the development MongoDB instance on `mongodb://localhost:4001`.
+To open your default browser you can pass the `--open` flag.
+For example: `meteor run --open`
+
Run `meteor help run` to see the full list of options.
meteor debug
@@ -83,21 +86,24 @@ option to other `meteor` tool commands, such as `meteor run` and `meteor test-pa
meteor create app-name
-The command `meteor create app-name` is the default command for creating a new Meteor project. It creates a subdirectory
-named `app-name` and copies a template app into it. You can pass an absolute or relative path. If you pass a relative
+The command `meteor create app-name` is the default command for creating a new Meteor project. It creates a subdirectory
+named `app-name` and copies a template app into it. You can pass an absolute or relative path. If you pass a relative
path, it will be resolved relative to the current working directory. By default, it generates a React project.
See the flags below to learn how you can generate different types of apps.
+Using only `meteor create` will create a promt to help you choose the type of app you want to create,
+giving you the options with the flags below.
+
--apollo
-The command `meteor create --apollo app-name` creates a Meteor app with [React](https://react.dev/),
-[Apollo](https://www.apollographql.com/) (GraphQL), and [MongoDB](https://www.mongodb.com/). To create a complete app,
-including testing and deployment, follow the [React tutorial](https://react-tutorial.meteor.com/). To learn how to use
+The command `meteor create --apollo app-name` creates a Meteor app with [React](https://react.dev/),
+[Apollo](https://www.apollographql.com/) (GraphQL), and [MongoDB](https://www.mongodb.com/). To create a complete app,
+including testing and deployment, follow the [React tutorial](https://react-tutorial.meteor.com/). To learn how to use
Apollo, refer to the [GraphQL section](https://react-tutorial.meteor.com/simple-todos-graphql/).
-Npm packages included: `@apollo/client`, `@apollo/server`, `@babel/runtime`, `body-parser`, `express`,
+Npm packages included: `@apollo/client`, `@apollo/server`, `@babel/runtime`, `body-parser`, `express`,
`graphql` `meteor-node-stubs`, `react`, `react-dom`.
Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive-var`, `standard-minifier-css`,
@@ -107,7 +113,7 @@ Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive
--bare
-The command `meteor create --bare app-name` creates an empty Meteor app with [Blaze](https://blazejs.org) and
+The command `meteor create --bare app-name` creates an empty Meteor app with [Blaze](https://blazejs.org) and
[MongoDB](https://www.mongodb.com/). To create a complete app, including testing and deployment, follow the
[Blaze tutorial](https://blaze-tutorial.meteor.com/).
@@ -119,22 +125,22 @@ Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive
--blaze
-The command `meteor create --blaze app-name` creates a Meteor app with [Blaze](https://blazejs.org) and
+The command `meteor create --blaze app-name` creates a Meteor app with [Blaze](https://blazejs.org) and
[MongoDB](https://www.mongodb.com/). To create a complete app, including testing and deployment, follow the
[Blaze tutorial](https://blaze-tutorial.meteor.com/).
Npm packages included: `@babel/runtime`, `meteor-node-stubs`, `jquery`.
Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `blaze-html-templates`, `jquery`, `reactive-var`,
-`tracker`, `standard-minifier-css`, `standard-minifier-js`, `es5-shim`, `ecmascript`, `typescript`, `shell-server`,
+`tracker`, `standard-minifier-css`, `standard-minifier-js`, `es5-shim`, `ecmascript`, `typescript`, `shell-server`,
`hot-module-replacement`, `blaze-hot`.
--chakra-ui
-The command `meteor create --chakra-ui app-name` creates a Meteor app with [React](https://react.dev/),
-[Chakra-UI](https://chakra-ui.com/), and [MongoDB](https://www.mongodb.com/). To create a complete app, including
-testing and deployment, follow the [React tutorial](https://react-tutorial.meteor.com/). To learn how to use Chakra-UI,
+The command `meteor create --chakra-ui app-name` creates a Meteor app with [React](https://react.dev/),
+[Chakra-UI](https://chakra-ui.com/), and [MongoDB](https://www.mongodb.com/). To create a complete app, including
+testing and deployment, follow the [React tutorial](https://react-tutorial.meteor.com/). To learn how to use Chakra-UI,
refer to the [Simple Tasks](https://github.com/fredmaiaarantes/simpletasks) example.
Npm packages included: `@babel/runtime`, `meteor-node-stubs`, `react`, `react-dom`, `@chakra-ui/icons`, `@chakra-ui/react`, `@emotion/react`
@@ -147,10 +153,10 @@ Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive
--full
-The command `meteor create --full app-name` creates a Meteor app with [Blaze](https://blazejs.org) and
+The command `meteor create --full app-name` creates a Meteor app with [Blaze](https://blazejs.org) and
[MongoDB](https://www.mongodb.com/). It creates a more complete, imports-based project that closely matches the
-[file structure](https://guide.meteor.com/structure.html#javascript-structure) recommended by the
-[Meteor Guide](https://guide.meteor.com/). To create a complete app, including testing and deployment, follow the
+[file structure](https://guide.meteor.com/structure.html#javascript-structure) recommended by the
+[Meteor Guide](https://guide.meteor.com/). To create a complete app, including testing and deployment, follow the
[Blaze tutorial](https://blaze-tutorial.meteor.com/).
Npm packages included: `@babel/runtime`, `meteor-node-stubs`, `jquery`, `chai`.
@@ -172,7 +178,7 @@ Meteor packages included: `meteor`, `standard-minifier-css`, `standard-minifier-
--package
-The command `meteor create --package package-name` creates a new package. If used in an existing app, it will create a
+The command `meteor create --package package-name` creates a new package. If used in an existing app, it will create a
package in the `packages` directory. Check the [Meteor Guide](https://guide.meteor.com/writing-atmosphere-packages.html)
for more information on how to get started writing packages.
@@ -180,7 +186,7 @@ for more information on how to get started writing packages.
--prototype
The command `meteor create --prototype app-name` creates a project with the prototype purpose packages (`autopublish`
-and `insecure`). If you use them, you can change your collections quickly and create prototype apps very quickly.
+and `insecure`). If you use them, you can change your collections quickly and create prototype apps very quickly.
However, these packages are not supposed to be used in production.
For more information about security, you can read our [security checklist](https://guide.meteor.com/security.html#checklist).
@@ -189,28 +195,28 @@ It can be used with other flags that create apps, such as `--react`, `blaze`, or
--react
-The command `meteor create --react app-name` creates a Meteor app with [React](https://react.dev/) and
-[MongoDB](https://www.mongodb.com/). It functions in the same way as if you don't use any flags. To create a complete
+The command `meteor create --react app-name` creates a Meteor app with [React](https://react.dev/) and
+[MongoDB](https://www.mongodb.com/). It functions in the same way as if you don't use any flags. To create a complete
app, including testing and deployment, follow the [React tutorial](https://react-tutorial.meteor.com/).
Npm packages included: `@babel/runtime`, `meteor-node-stubs`, `react`, `react-dom`.
-Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive-var`, `standard-minifier-css`,
+Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive-var`, `standard-minifier-css`,
`standard-minifier-js`, `es5-shim`, `ecmascript`, `typescript`, `shell-server`, `hot-module-replacement`, `static-html`,
`react-meteor-data`.
--release
-The command `meteor create app-name --release {meteor-version}` creates a Meteor app with the release specified in the
-command. For instance, you can create a Meteor app with the `2.8` release using `meteor create app-name --release 2.8`.
-By default, it generates a React app, but you can use it with other flags that create apps such as `--blaze`,
+The command `meteor create app-name --release {meteor-version}` creates a Meteor app with the release specified in the
+command. For instance, you can create a Meteor app with the `2.8` release using `meteor create app-name --release 2.8`.
+By default, it generates a React app, but you can use it with other flags that create apps such as `--blaze`,
`--svelte`, `--vue`, or `--typescript`.
--solid
-The command `meteor create --solid app-name` creates a Meteor app with [Solid](https://www.solidjs.com/),
+The command `meteor create --solid app-name` creates a Meteor app with [Solid](https://www.solidjs.com/),
[Vite](https://vitejs.dev/), and [MongoDB](https://www.mongodb.com/). You can see an example on the
[meteor-solid-app](https://github.com/fredmaiaarantes/meteor-solid-app/releases/tag/milestone-2.0) repository.
@@ -223,7 +229,7 @@ Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive
--svelte
-The command `meteor create --svelte app-name` creates a Meteor app with [Svelte](https://svelte.dev/) and
+The command `meteor create --svelte app-name` creates a Meteor app with [Svelte](https://svelte.dev/) and
[MongoDB](https://www.mongodb.com/). To create a complete app, including testing and deployment, follow the
[Svelte tutorial](https://svelte-tutorial.meteor.com/).
@@ -239,7 +245,7 @@ You can see an example on the [meteor-vite](https://github.com/JorgenVatle/meteo
--tailwind
-The command `meteor create --tailwind app-name` creates a Meteor app with [React](https://react.dev/),
+The command `meteor create --tailwind app-name` creates a Meteor app with [React](https://react.dev/),
[Tailwind CSS](https://tailwindcss.com), and [MongoDB](https://www.mongodb.com/).
Npm packages included: `@babel/runtime`, `meteor-node-stubs`, `react`, `react-dom`, `autoprefixer`, `postcss`, `postcss-load-config`, `tailwindcss`.
@@ -251,9 +257,9 @@ Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive
--typescript
-The command `meteor create --typescript app-name` creates a Meteor app with [React](https://react.dev/),
-[TypeScript](https://www.typescriptlang.org/), and [MongoDB](https://www.mongodb.com/). Check the
-[Meteor Guide](https://guide.meteor.com/build-tool.html#typescript) for more information about TypeScript and how to
+The command `meteor create --typescript app-name` creates a Meteor app with [React](https://react.dev/),
+[TypeScript](https://www.typescriptlang.org/), and [MongoDB](https://www.mongodb.com/). Check the
+[Meteor Guide](https://guide.meteor.com/build-tool.html#typescript) for more information about TypeScript and how to
use it with other UI frameworks.
Npm packages included: `@babel/runtime`, `meteor-node-stubs`, `react`, `react-dom`, `@types/mocha`, `@types/node`, `@types/react`, `@types/react-dom`, `typescript`.
@@ -265,8 +271,8 @@ Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive
--vue
-The command `meteor create --vue app-name` creates a Meteor app with [Vue 3](https://vuejs.org/),
-[Tailwind CSS](https://tailwindcss.com), [Vite](https://vitejs.dev/), and [MongoDB](https://www.mongodb.com/). To
+The command `meteor create --vue app-name` creates a Meteor app with [Vue 3](https://vuejs.org/),
+[Tailwind CSS](https://tailwindcss.com), [Vite](https://vitejs.dev/), and [MongoDB](https://www.mongodb.com/). To
create a complete app, including testing and deployment, follow the [Vue 3 tutorial](https://vue3-tutorial.meteor.com/).
Npm packages included: `@babel/runtime`, `meteor-node-stubs`, `vue`, `vue-meteor-tracker`, `vue-router`, `@types/meteor`, `@vitejs/plugin-vue`, `autoprefixer`, `postcss`, `tailwindcss`, `vite`.
@@ -276,23 +282,9 @@ Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive
`vite:bundler`.
You can also use Vue 3 with Vite by using the [jorgenvatle:meteor-vite](https://github.com/JorgenVatle/meteor-vite)
-package. You can see an example on the [meteor-vite](https://github.com/JorgenVatle/meteor-vite/tree/release/examples/vue)
+package. You can see an example on the [meteor-vite](https://github.com/JorgenVatle/meteor-vite/tree/release/examples/vue)
repository.
-
-
--vue-2
-
-The command `meteor create --vue-2 app-name` creates a Meteor app with [Vue 2](https://v2.vuejs.org/) and
-[MongoDB](https://www.mongodb.com/). To create a complete app, including testing and deployment, follow the
-[Vue 2 tutorial](https://vue-tutorial.meteor.com/).
-
-Npm packages included: `@babel/runtime`, `meteor-node-stubs`, `vue`, `vue-meteor-tracker`.
-
-Meteor packages included: `meteor-base`, `mobile-experience`, `mongo`, `reactive-var`, `standard-minifier-css`,
-`standard-minifier-js`, `es5-shim`, `ecmascript`, `typescript`, `shell-server`, `tracker`, `static-html`, `akryum:vue-component`,
-`meteortesting:mocha`, `johanbrook:publication-collector`.
-
-
meteor generate
``meteor generate`` is a command for generating scaffolds for your current project. When ran without arguments, it will ask
@@ -303,7 +295,7 @@ used as a command line only operation as well.
> By default, the generator will use JavaScript but if it detects that you have a
``tsconfig.json`` file in your project, it will use TypeScript instead.
-running
+running
```bash
meteor generate customer
@@ -511,7 +503,7 @@ It will prompt the following questions.
----
+---
Using your own template
@@ -533,7 +525,7 @@ You can use your own templates for scaffolding your specific workloads. To do th
Out of the box is provided a few functions such as replacing ``$$name$$``, ``$$PascalName$$`` and ``$$camelName$$``
these replacements come from this function:
-
+
_Note that scaffoldName is the name that you have passed as argument_
```js
@@ -661,7 +653,7 @@ If you want to connect to your free MongoDB shared cluster using your on setting
```
packages: {
mongo: {
- options: {
+ options: {
tlsAllowInvalidCertificates: true,
},
},
@@ -685,7 +677,7 @@ Your project should be a git repository as the commit hash is going to be used t
The `cache-build` option is available since Meteor 1.11.
{% endpullquote %}
-With the argument `--container-size` you can change your app's container size using the deploy command. The valid arguments are: `tiny`, `compact`, `standard`, `double`, `quad`, `octa`, and `dozen`. One more thing to note here is that the `--container-size` flag can only be used when the `--plan` option is already specified, otherwise using the `--container-size` option will throw an error with the message : `Error deploying application: Internal error`. To see more about the difference and prices of each one you can check [here](https://www.meteor.com/cloud#pricing-section).
+With the argument `--container-size` you can change your app's container size using the deploy command. The valid arguments are: `tiny`, `compact`, `standard`, `double`, `quad`, `octa`, and `dozen`. One more thing to note here is that the `--container-size` flag can only be used when the `--plan` option is already specified, otherwise using the `--container-size` option will throw an error with the message : `Error deploying application: Internal error`. To see more about the difference and prices of each one you can check [here](https://galaxycloud.app/meteorjs/pricing).
{% pullquote warning %}
The `--container-size` option is available since Meteor 2.4.1.
@@ -912,7 +904,7 @@ upload the build to the architecture that you were using to publish it. You can
use `publish-for-arch` to upload a build to a different architecture from a
different machine.
-If you have already published a package but need to update it's metadata
+If you have already published a package but need to update it's metadata
(the content of `Package.describe`) or the README you can actually achieve this
via `meteor publish --update`.
diff --git a/docs/source/environment-variables.md b/docs/source/environment-variables.md
index 807851ac47..4c8ebb8bf2 100644
--- a/docs/source/environment-variables.md
+++ b/docs/source/environment-variables.md
@@ -15,7 +15,7 @@ See also: [`PORT`](#PORT).
> In development, this can be accomplished with `meteor run --port a.b.c.d:port`.
## DDP_DEFAULT_CONNECTION_URL
-(_develoment, production_)
+(_development, production_)
There are some situations where it is valuable for the meteor client to use a different DDP server than the `ROOT_URL` server.
@@ -33,6 +33,11 @@ In the event that your own deployment platform does not support WebSockets, or y
Set `DISABLE_SOCKJS=1` if you want to use the native WebSocket implementation instead of SockJS on the client side, for example, if you want to use a custom WebSocket implementation (e.g. [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js/)) on the server side.
+## DISABLE_SOCKJS_CORS
+(_development, production_)
+
+Set `DISABLE_SOCKJS_CORS=1` if you want to prevent SockJS from setting CORS headers. Do not set this option if you will have DDP clients from other origins connecting to the DDP server.
+
## HTTP_FORWARDED_COUNT
(_production_)
@@ -72,7 +77,7 @@ When running your bundled application in production mode, pass a string of JSON
## METEOR_SQLITE_JOURNAL_MODE
(_development_)
-The Meteor package catalog uses the `WAL` [SQLite Journal Mode](https://www.sqlite.org/pragma.html#pragma_journal_mode) by default. The Journal mode for the package catalog can be modifed by setting `METEOR_SQLITE_JOURNAL_MODE`.
+The Meteor package catalog uses the `WAL` [SQLite Journal Mode](https://www.sqlite.org/pragma.html#pragma_journal_mode) by default. The Journal mode for the package catalog can be modified by setting `METEOR_SQLITE_JOURNAL_MODE`.
When running multiple concurrent meteor servers on [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/) some meteor developers have seen issues with the package catalog. Setting the environment variable `METEOR_SQLITE_JOURNAL_MODE=TRUNCATE` can overcome the issue.
diff --git a/docs/source/index.md b/docs/source/index.md
index 6e196d5596..208309701d 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -2,7 +2,7 @@
title: Docs
---
-> Meteor 2.x runs on a deprecated Node.js version (14). Meteor 3.0 is in progress, and it will run on the latest Node.js version. For more information, please consult our [migration guide](https://guide.meteor.com/3.0-migration.html).
+> Meteor 2.x runs on a deprecated Node.js version (14). Meteor 3 has been released with support for the latest Node.js LTS version. For more information, please consult our [migration guide](https://v3-migration-docs.meteor.com/) and the [latest docs](https://v3-docs.meteor.com).
What is Meteor?
@@ -24,11 +24,11 @@ Meteor is a full-stack JavaScript platform for developing modern web and mobile
1. The place to get started with Meteor is the [tutorials page](https://www.meteor.com/developers/tutorials).
1. [Meteor Examples](https://github.com/meteor/examples) is a list of examples using Meteor. You can also include your example with Meteor.
-
+
1. Once you are familiar with the basics, the [Meteor Guide](http://guide.meteor.com) covers intermediate material on how to use Meteor in a larger scale app.
1. Visit the [Meteor discussion forums](https://forums.meteor.com) to announce projects, get help, talk about the community, or discuss changes to core.
-
+
1. [Meteor Slack Community](https://join.slack.com/t/meteor-community/shared_invite/enQtODA0NTU2Nzk5MTA3LWY5NGMxMWRjZDgzYWMyMTEyYTQ3MTcwZmU2YjM5MTY3MjJkZjQ0NWRjOGZlYmIxZjFlYTA5Mjg4OTk3ODRiOTc) is the best place to ask (and answer!) technical questions and also meet Meteor developers.
1. [Atmosphere](https://atmospherejs.com) is the repository of community packages designed especially for Meteor.
diff --git a/docs/source/install.md b/docs/source/install.md
index 8f26fa65d3..6a58d65cfd 100644
--- a/docs/source/install.md
+++ b/docs/source/install.md
@@ -8,7 +8,7 @@ You need to install the Meteor command line tool to create, run, and manage your
Node.js version
-> Meteor 2.x runs on a deprecated Node.js version (14). Meteor 3.0 is in progress, and it will run on the latest Node.js version. For more information, please consult our [migration guide](https://guide.meteor.com/3.0-migration.html).
+> Meteor 2.x runs on a deprecated Node.js version (14). Meteor 3 has been released with support for the latest Node.js LTS version. For more information, please consult our [migration guide](https://v3-migration-docs.meteor.com/) and the [latest docs](https://v3-docs.meteor.com).
- Node.js version >= 10 and <= 14 is required.
- We recommend you using [nvm](https://github.com/nvm-sh/nvm) or [Volta](https://volta.sh/) for managing Node.js versions.
@@ -30,10 +30,13 @@ You need to install the Meteor command line tool to create, run, and manage your
Install the latest official version of Meteor.js from your terminal by running one of the commands below. You can check our [changelog](https://docs.meteor.com/changelog.html) for the release notes.
-> Run `node -v` to ensure you are using Node.js 14. Meteor 3.0 is in progress, and it will run on the latest Node.js version.
+> Meteor 2.x runs on a deprecated Node.js version (14). Meteor 3 is released with support for the latest Node.js LTS version.
+> For more information, please consult our [migration guide](https://guide.meteor.com/3.0-migration.html) and the [new docs](https://docs.meteor.com/).
For Windows, Linux and OS X, you can run the following command:
+> Preferably, do not use `sudo` to install Meteor. If you need to use `sudo`, please check the [troubleshooting section](#troubleshooting).
+
```bash
npm install -g meteor
```
@@ -67,6 +70,8 @@ If you only use sudo because of a distribution default permission system, [check
In some cases you can get this error `npm WARN checkPermissions Missing write access to /usr/local/lib/node_modules` because your Node.js installation was performed with wrong permissions. An easy way to fix this is to install Node.js using [nvm](https://github.com/nvm-sh/nvm) and forcing it to be used in your terminal. You can force it in the current session of your terminal by running `nvm use 14`.
+As a last resort you can delete the `.meteor` folder in your home directory and try to install Meteor again using the correct permissions.
+
PATH management
By default, the Meteor installer adds its install path (by default, `~/.meteor/`) to your PATH by updating either your `.bashrc`, `.bash_profile`, or `.zshrc` as appropriate. To disable this behavior, install Meteor by running:
@@ -118,5 +123,4 @@ If you installed Meteor using npm, you can remove it by running:
If you installed Meteor using curl, you can remove it by running:
`rm -rf ~/.meteor`
-`sudo rm /usr/local/bin/meteor`Β
-
+`sudo rm /usr/local/bin/meteor`
diff --git a/docs/source/packages/fetch.md b/docs/source/packages/fetch.md
index 4f5176e374..016c0329f7 100644
--- a/docs/source/packages/fetch.md
+++ b/docs/source/packages/fetch.md
@@ -3,7 +3,7 @@ title: fetch
description: Isomorphic modern/legacy/Node polyfill for WHATWG fetch().
---
-This package replaces the `http` package for HTTP calls. `fetch` package provides polyfill for the [WHATWG fetch specification](https://fetch.spec.whatwg.org/) for legacy browsers or defaults to the global class which is available in modern browsers and Node. It is recomended that you use this package for compatibility with non-modern browsers.
+This package replaces the `http` package for HTTP calls. `fetch` package provides polyfill for the [WHATWG fetch specification](https://fetch.spec.whatwg.org/) for legacy browsers or defaults to the global class which is available in modern browsers and Node. It is recommended that you use this package for compatibility with non-modern browsers.
For more information we recommend [reading the MDN articles](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) about it as this article covers only basic usage in Meteor.
diff --git a/docs/source/packages/logging.md b/docs/source/packages/logging.md
index 6c2013d7a2..8f3fa18338 100644
--- a/docs/source/packages/logging.md
+++ b/docs/source/packages/logging.md
@@ -3,7 +3,7 @@ title: logging
description: Documentation of Meteor's logging utility
---
-The `logging` package provides a standartised way for you to log and display in console various message from your application.
+The `logging` package provides a standardised way for you to log and display in console various message from your application.
The added benefit is that among other data it will show you the location where the log was fired,
this is useful during debugging to quickly locate where the message is coming from.
diff --git a/docs/source/packages/modules.md b/docs/source/packages/modules.md
index 0f01c8ef6c..adc2b359c9 100644
--- a/docs/source/packages/modules.md
+++ b/docs/source/packages/modules.md
@@ -323,7 +323,7 @@ import { exportedPackageMethod } from "meteor/
";
```
> Note: Packages with `lazy` main modules cannot use `api.export` to export global
-symbols to other packages/apps. Also, prior to Meteor 1.4.4.2 it is neccessary to explicitly name the file containing the module: `import "meteor//client.js"`.
+symbols to other packages/apps. Also, prior to Meteor 1.4.4.2 it is necessary to explicitly name the file containing the module: `import "meteor//client.js"`.
## Local `node_modules`
diff --git a/docs/source/packages/oauth-encryption.md b/docs/source/packages/oauth-encryption.md
index 8b9e651ec4..bc78e63647 100644
--- a/docs/source/packages/oauth-encryption.md
+++ b/docs/source/packages/oauth-encryption.md
@@ -31,10 +31,16 @@ the top level of your source file), not called from inside of a
`Meteor.startup` block.
To avoid storing the secret key in your application's source code, you
-can use [`Meteor.settings`](http://docs.meteor.com/#meteor_settings):
+can provide the same value under [`Meteor.settings.packages.accounts-base.oauthSecretKey`](http://docs.meteor.com/#meteor_settings):
-```js
-Accounts.config({ oauthSecretKey: Meteor.settings.oauthSecretKey });
+```json
+{
+ "packages": {
+ "accounts-base": {
+ "oauthSecretKey": "onsqJ+1e4iGFlV0nhZYobg=="
+ }
+ }
+}
```
diff --git a/docs/source/packages/packages-listing.md b/docs/source/packages/packages-listing.md
new file mode 100644
index 0000000000..dca65fde57
--- /dev/null
+++ b/docs/source/packages/packages-listing.md
@@ -0,0 +1,158 @@
+
+---
+title: Core Package Listing
+description: list of all Meteor core packages.
+---
+
+[//]: # (Do not edit this file by hand.)
+
+[//]: # (This is a generated file.)
+
+[//]: # (If you want to change something in this file)
+
+[//]: # (go to meteor/docs/generators/packages-listing)
+
+# Core Packages
+
+
+- [blaze](https://github.com/meteor/blaze)
+- [react-packages](https://github.com/meteor/react-packages)
+- [accounts-2fa](https://github.com/meteor/meteor/tree/devel/packages/accounts-2fa)
+- [accounts-base](https://github.com/meteor/meteor/tree/devel/packages/accounts-base)
+- [accounts-facebook](https://github.com/meteor/meteor/tree/devel/packages/accounts-facebook)
+- [accounts-github](https://github.com/meteor/meteor/tree/devel/packages/accounts-github)
+- [accounts-google](https://github.com/meteor/meteor/tree/devel/packages/accounts-google)
+- [accounts-meetup](https://github.com/meteor/meteor/tree/devel/packages/accounts-meetup)
+- [accounts-meteor-developer](https://github.com/meteor/meteor/tree/devel/packages/accounts-meteor-developer)
+- [accounts-oauth](https://github.com/meteor/meteor/tree/devel/packages/accounts-oauth)
+- [accounts-password](https://github.com/meteor/meteor/tree/devel/packages/accounts-password)
+- [accounts-passwordless](https://github.com/meteor/meteor/tree/devel/packages/accounts-passwordless)
+- [accounts-twitter](https://github.com/meteor/meteor/tree/devel/packages/accounts-twitter)
+- [accounts-ui](https://github.com/meteor/meteor/tree/devel/packages/accounts-ui)
+- [accounts-ui-unstyled](https://github.com/meteor/meteor/tree/devel/packages/accounts-ui-unstyled)
+- [accounts-weibo](https://github.com/meteor/meteor/tree/devel/packages/accounts-weibo)
+- [allow-deny](https://github.com/meteor/meteor/tree/devel/packages/allow-deny)
+- [audit-argument-checks](https://github.com/meteor/meteor/tree/devel/packages/audit-argument-checks)
+- [autopublish](https://github.com/meteor/meteor/tree/devel/packages/autopublish)
+- [autoupdate](https://github.com/meteor/meteor/tree/devel/packages/autoupdate)
+- [babel-compiler](https://github.com/meteor/meteor/tree/devel/packages/babel-compiler)
+- [babel-runtime](https://github.com/meteor/meteor/tree/devel/packages/babel-runtime)
+- [base64](https://github.com/meteor/meteor/tree/devel/packages/base64)
+- [binary-heap](https://github.com/meteor/meteor/tree/devel/packages/binary-heap)
+- [boilerplate-generator](https://github.com/meteor/meteor/tree/devel/packages/boilerplate-generator)
+- [boilerplate-generator-tests](https://github.com/meteor/meteor/tree/devel/packages/boilerplate-generator-tests)
+- [browser-policy](https://github.com/meteor/meteor/tree/devel/packages/browser-policy)
+- [browser-policy-common](https://github.com/meteor/meteor/tree/devel/packages/browser-policy-common)
+- [browser-policy-content](https://github.com/meteor/meteor/tree/devel/packages/browser-policy-content)
+- [browser-policy-framing](https://github.com/meteor/meteor/tree/devel/packages/browser-policy-framing)
+- [caching-compiler](https://github.com/meteor/meteor/tree/devel/packages/caching-compiler)
+- [callback-hook](https://github.com/meteor/meteor/tree/devel/packages/callback-hook)
+- [check](https://github.com/meteor/meteor/tree/devel/packages/check)
+- [constraint-solver](https://github.com/meteor/meteor/tree/devel/packages/constraint-solver)
+- [context](https://github.com/meteor/meteor/tree/devel/packages/context)
+- [crosswalk](https://github.com/meteor/meteor/tree/devel/packages/crosswalk)
+- [ddp](https://github.com/meteor/meteor/tree/devel/packages/ddp)
+- [ddp-client](https://github.com/meteor/meteor/tree/devel/packages/ddp-client)
+- [ddp-common](https://github.com/meteor/meteor/tree/devel/packages/ddp-common)
+- [ddp-rate-limiter](https://github.com/meteor/meteor/tree/devel/packages/ddp-rate-limiter)
+- [ddp-server](https://github.com/meteor/meteor/tree/devel/packages/ddp-server)
+- [deprecated](https://github.com/meteor/meteor/tree/devel/packages/deprecated)
+- [dev-error-overlay](https://github.com/meteor/meteor/tree/devel/packages/dev-error-overlay)
+- [diff-sequence](https://github.com/meteor/meteor/tree/devel/packages/diff-sequence)
+- [disable-oplog](https://github.com/meteor/meteor/tree/devel/packages/disable-oplog)
+- [dynamic-import](https://github.com/meteor/meteor/tree/devel/packages/dynamic-import)
+- [ecmascript](https://github.com/meteor/meteor/tree/devel/packages/ecmascript)
+- [ecmascript-runtime](https://github.com/meteor/meteor/tree/devel/packages/ecmascript-runtime)
+- [ecmascript-runtime-client](https://github.com/meteor/meteor/tree/devel/packages/ecmascript-runtime-client)
+- [ecmascript-runtime-server](https://github.com/meteor/meteor/tree/devel/packages/ecmascript-runtime-server)
+- [ejson](https://github.com/meteor/meteor/tree/devel/packages/ejson)
+- [email](https://github.com/meteor/meteor/tree/devel/packages/email)
+- [es5-shim](https://github.com/meteor/meteor/tree/devel/packages/es5-shim)
+- [facebook-config-ui](https://github.com/meteor/meteor/tree/devel/packages/facebook-config-ui)
+- [facebook-oauth](https://github.com/meteor/meteor/tree/devel/packages/facebook-oauth)
+- [facts-base](https://github.com/meteor/meteor/tree/devel/packages/facts-base)
+- [facts-ui](https://github.com/meteor/meteor/tree/devel/packages/facts-ui)
+- [fetch](https://github.com/meteor/meteor/tree/devel/packages/fetch)
+- [force-ssl](https://github.com/meteor/meteor/tree/devel/packages/force-ssl)
+- [force-ssl-common](https://github.com/meteor/meteor/tree/devel/packages/force-ssl-common)
+- [geojson-utils](https://github.com/meteor/meteor/tree/devel/packages/geojson-utils)
+- [github-config-ui](https://github.com/meteor/meteor/tree/devel/packages/github-config-ui)
+- [github-oauth](https://github.com/meteor/meteor/tree/devel/packages/github-oauth)
+- [google-config-ui](https://github.com/meteor/meteor/tree/devel/packages/google-config-ui)
+- [google-oauth](https://github.com/meteor/meteor/tree/devel/packages/google-oauth)
+- [hot-code-push](https://github.com/meteor/meteor/tree/devel/packages/hot-code-push)
+- [hot-module-replacement](https://github.com/meteor/meteor/tree/devel/packages/hot-module-replacement)
+- [id-map](https://github.com/meteor/meteor/tree/devel/packages/id-map)
+- [insecure](https://github.com/meteor/meteor/tree/devel/packages/insecure)
+- [inter-process-messaging](https://github.com/meteor/meteor/tree/devel/packages/inter-process-messaging)
+- [launch-screen](https://github.com/meteor/meteor/tree/devel/packages/launch-screen)
+- [localstorage](https://github.com/meteor/meteor/tree/devel/packages/localstorage)
+- [logging](https://github.com/meteor/meteor/tree/devel/packages/logging)
+- [logic-solver](https://github.com/meteor/meteor/tree/devel/packages/logic-solver)
+- [meetup-config-ui](https://github.com/meteor/meteor/tree/devel/packages/meetup-config-ui)
+- [meetup-oauth](https://github.com/meteor/meteor/tree/devel/packages/meetup-oauth)
+- [meteor](https://github.com/meteor/meteor/tree/devel/packages/meteor)
+- [meteor-base](https://github.com/meteor/meteor/tree/devel/packages/meteor-base)
+- [meteor-developer-config-ui](https://github.com/meteor/meteor/tree/devel/packages/meteor-developer-config-ui)
+- [meteor-developer-oauth](https://github.com/meteor/meteor/tree/devel/packages/meteor-developer-oauth)
+- [meteor-platform](https://github.com/meteor/meteor/tree/devel/packages/meteor-platform)
+- [meteor-tool](https://github.com/meteor/meteor/tree/devel/packages/meteor-tool)
+- [minifier-css](https://github.com/meteor/meteor/tree/devel/packages/minifier-css)
+- [minifier-js](https://github.com/meteor/meteor/tree/devel/packages/minifier-js)
+- [minimongo](https://github.com/meteor/meteor/tree/devel/packages/minimongo)
+- [mobile-experience](https://github.com/meteor/meteor/tree/devel/packages/mobile-experience)
+- [mobile-status-bar](https://github.com/meteor/meteor/tree/devel/packages/mobile-status-bar)
+- [modern-browsers](https://github.com/meteor/meteor/tree/devel/packages/modern-browsers)
+- [modules](https://github.com/meteor/meteor/tree/devel/packages/modules)
+- [modules-runtime](https://github.com/meteor/meteor/tree/devel/packages/modules-runtime)
+- [modules-runtime-hot](https://github.com/meteor/meteor/tree/devel/packages/modules-runtime-hot)
+- [mongo](https://github.com/meteor/meteor/tree/devel/packages/mongo)
+- [mongo-dev-server](https://github.com/meteor/meteor/tree/devel/packages/mongo-dev-server)
+- [mongo-id](https://github.com/meteor/meteor/tree/devel/packages/mongo-id)
+- [mongo-livedata](https://github.com/meteor/meteor/tree/devel/packages/mongo-livedata)
+- [npm-mongo](https://github.com/meteor/meteor/tree/devel/packages/npm-mongo)
+- [oauth](https://github.com/meteor/meteor/tree/devel/packages/oauth)
+- [oauth-encryption](https://github.com/meteor/meteor/tree/devel/packages/oauth-encryption)
+- [oauth1](https://github.com/meteor/meteor/tree/devel/packages/oauth1)
+- [oauth2](https://github.com/meteor/meteor/tree/devel/packages/oauth2)
+- [ordered-dict](https://github.com/meteor/meteor/tree/devel/packages/ordered-dict)
+- [package-stats-opt-out](https://github.com/meteor/meteor/tree/devel/packages/package-stats-opt-out)
+- [package-version-parser](https://github.com/meteor/meteor/tree/devel/packages/package-version-parser)
+- [promise](https://github.com/meteor/meteor/tree/devel/packages/promise)
+- [random](https://github.com/meteor/meteor/tree/devel/packages/random)
+- [rate-limit](https://github.com/meteor/meteor/tree/devel/packages/rate-limit)
+- [react-fast-refresh](https://github.com/meteor/meteor/tree/devel/packages/react-fast-refresh)
+- [reactive-dict](https://github.com/meteor/meteor/tree/devel/packages/reactive-dict)
+- [reactive-var](https://github.com/meteor/meteor/tree/devel/packages/reactive-var)
+- [reload](https://github.com/meteor/meteor/tree/devel/packages/reload)
+- [reload-safetybelt](https://github.com/meteor/meteor/tree/devel/packages/reload-safetybelt)
+- [retry](https://github.com/meteor/meteor/tree/devel/packages/retry)
+- [routepolicy](https://github.com/meteor/meteor/tree/devel/packages/routepolicy)
+- [server-render](https://github.com/meteor/meteor/tree/devel/packages/server-render)
+- [service-configuration](https://github.com/meteor/meteor/tree/devel/packages/service-configuration)
+- [session](https://github.com/meteor/meteor/tree/devel/packages/session)
+- [sha](https://github.com/meteor/meteor/tree/devel/packages/sha)
+- [shell-server](https://github.com/meteor/meteor/tree/devel/packages/shell-server)
+- [socket-stream-client](https://github.com/meteor/meteor/tree/devel/packages/socket-stream-client)
+- [standard-app-packages](https://github.com/meteor/meteor/tree/devel/packages/standard-app-packages)
+- [standard-minifier-css](https://github.com/meteor/meteor/tree/devel/packages/standard-minifier-css)
+- [standard-minifier-js](https://github.com/meteor/meteor/tree/devel/packages/standard-minifier-js)
+- [standard-minifiers](https://github.com/meteor/meteor/tree/devel/packages/standard-minifiers)
+- [static-html](https://github.com/meteor/meteor/tree/devel/packages/static-html)
+- [test-helpers](https://github.com/meteor/meteor/tree/devel/packages/test-helpers)
+- [test-in-browser](https://github.com/meteor/meteor/tree/devel/packages/test-in-browser)
+- [test-in-console](https://github.com/meteor/meteor/tree/devel/packages/test-in-console)
+- [test-server-tests-in-console-once](https://github.com/meteor/meteor/tree/devel/packages/test-server-tests-in-console-once)
+- [tinytest](https://github.com/meteor/meteor/tree/devel/packages/tinytest)
+- [tinytest-harness](https://github.com/meteor/meteor/tree/devel/packages/tinytest-harness)
+- [tracker](https://github.com/meteor/meteor/tree/devel/packages/tracker)
+- [twitter-config-ui](https://github.com/meteor/meteor/tree/devel/packages/twitter-config-ui)
+- [twitter-oauth](https://github.com/meteor/meteor/tree/devel/packages/twitter-oauth)
+- [typescript](https://github.com/meteor/meteor/tree/devel/packages/typescript)
+- [underscore](https://github.com/meteor/meteor/tree/devel/packages/underscore)
+- [underscore-tests](https://github.com/meteor/meteor/tree/devel/packages/underscore-tests)
+- [url](https://github.com/meteor/meteor/tree/devel/packages/url)
+- [webapp](https://github.com/meteor/meteor/tree/devel/packages/webapp)
+- [webapp-hashing](https://github.com/meteor/meteor/tree/devel/packages/webapp-hashing)
+- [weibo-config-ui](https://github.com/meteor/meteor/tree/devel/packages/weibo-config-ui)
+- [weibo-oauth](https://github.com/meteor/meteor/tree/devel/packages/weibo-oauth)
\ No newline at end of file
diff --git a/docs/source/packages/url.md b/docs/source/packages/url.md
index a38971db91..4abeefcf5d 100644
--- a/docs/source/packages/url.md
+++ b/docs/source/packages/url.md
@@ -3,7 +3,7 @@ title: url
description: Isomorphic modern/legacy/Node polyfill for WHATWG URL/URLSearchParams.
---
-`url` package provides polyfill for the [WHATWG url specification](https://url.spec.whatwg.org/) for legacy browsers or defaults to the global class which is available in modern browsers and Node. It is recomended that you use this package for compatibility with non-modern browsers.
+`url` package provides polyfill for the [WHATWG url specification](https://url.spec.whatwg.org/) for legacy browsers or defaults to the global class which is available in modern browsers and Node. It is recommended that you use this package for compatibility with non-modern browsers.
For more information we recommend [reading the MDN articles](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) about it and looking over the [Node API documentation](https://nodejs.org/api/url.html#url_the_whatwg_url_api) for more details as this article covers only basic usage in Meteor.
diff --git a/docs/source/packages/webapp.md b/docs/source/packages/webapp.md
index b20d8a6edf..88d7574735 100644
--- a/docs/source/packages/webapp.md
+++ b/docs/source/packages/webapp.md
@@ -13,20 +13,20 @@ This package also allows you to add handlers for HTTP requests.
This lets other services access your app's data through an HTTP API, allowing
it to easily interoperate with tools and frameworks that don't yet support DDP.
-`webapp` exposes the [connect](https://github.com/senchalabs/connect) API for
-handling requests through `WebApp.connectHandlers`.
+`webapp` exposes the [express](https://github.com/expressjs/express) API for
+handling requests through `WebApp.handlers`.
Here's an example that will let you handle a specific URL:
```js
// Listen to incoming HTTP requests (can only be used on the server).
-WebApp.connectHandlers.use('/hello', (req, res, next) => {
+WebApp.handlers.use('/hello', (req, res, next) => {
res.writeHead(200);
res.end(`Hello world from: ${Meteor.release}`);
});
```
-{% apibox "WebApp.connectHandlers" %}
-{% apibox "connectHandlersCallback(req, res, next)" %}
+{% apibox "WebApp.handlers" %}
+{% apibox "expressHandlersCallback(req, res, next)" %}
### Serving a Static Landing Page
@@ -62,36 +62,38 @@ Here's a sample _index.html_ you might use to get started:
React](https://react-tutorial.meteor.com/) |
+| [
Blaze](https://blaze-tutorial.meteor.com/) |
-| [
Vue](https://vue-tutorial.meteor.com/) |
-| [
Svelte](https://svelte-tutorial.meteor.com/) |
-
-Next, read the [documentation](https://docs.meteor.com/) and get some [examples](https://github.com/meteor/examples).
+| [
+