Meteor Namespace

Global Meteor namespace API reference

Meteor Namespace API

The Meteor namespace provides the core API for Meteor applications on both client and server.

User Management

Meteor.userId()

Get the current user id, or null if no user is logged in. A reactive data source.

Locus: Anywhere

const userId = Meteor.userId();
if (userId) {
  console.log('User is logged in:', userId);
}

Reactive Example:

Tracker.autorun(() => {
  const userId = Meteor.userId();
  if (userId) {
    console.log('User changed:', userId);
  }
});

Meteor.user()

Get the current user record, or null if no user is logged in. A reactive data source.

Locus: Anywhere

options · object

Optional options object.

options.fields · object

Dictionary of fields to return or exclude.

const user = Meteor.user();
if (user) {
  console.log('Username:', user.username);
  console.log('Email:', user.emails[0].address);
}

// With field selection
const userProfile = Meteor.user({ fields: { profile: 1 } });

Note: On the server, Meteor.user() is deprecated. Use Meteor.userAsync() instead.

Meteor.userAsync()

Asynchronously get the current user record, or null if no user is logged in.

Locus: Anywhere

options · object

Optional options object.

options.fields · object

Dictionary of fields to return or exclude.

const user = await Meteor.userAsync();
if (user) {
  console.log('User email:', user.emails[0].address);
}

Authentication

Meteor.logout()

Log the user out.

Locus: Client

callback · function

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

Meteor.logout((error) => {
  if (error) {
    console.error('Logout failed:', error);
  } else {
    console.log('Logged out successfully');
  }
});

Meteor.logoutAllClients()

Log out all clients logged in as the current user and logs the current user out as well.

Locus: Client

Meteor.logoutAllClients((error) => {
  if (!error) {
    console.log('Logged out from all devices');
  }
});

Meteor.logoutOtherClients()

Log out other clients logged in as the current user, but does not log out the client that calls this function.

Locus: Client

Meteor.logoutOtherClients((error) => {
  if (!error) {
    console.log('Other sessions logged out');
  }
});

Meteor.loginWithPassword()

Log the user in with a password.

Locus: Client

selector · string | object · required

Either a string interpreted as a username or an email; or an object with a single key: email, username or id. Username or email match in a case insensitive manner.

password · string · required

The user’s password.

callback · function

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

// Login with username
Meteor.loginWithPassword('username', 'password', (error) => {
  if (error) {
    console.error('Login failed:', error);
  } else {
    console.log('Login successful');
  }
});

// Login with email
Meteor.loginWithPassword('[e-mail]', 'password', callback);

// Login with object selector
Meteor.loginWithPassword({ email: '[e-mail]' }, 'password', callback);

Meteor.loginWithToken()

Login with a Meteor access token.

Locus: Client

token · string · required

Local storage token for use with login across multiple tabs in the same browser.

callback · function

Optional callback. Called with no arguments on success.

const token = localStorage.getItem('Meteor.loginToken');
Meteor.loginWithToken(token, (error) => {
  if (!error) {
    console.log('Logged in with token');
  }
});

Connection Management

Meteor.status()

Get the current connection status. A reactive data source.

Locus: Client

connected · boolean

True if currently connected to the server.

status · string

Connection status: “connected”, “connecting”, “failed”, “waiting”, or “offline”.

retryCount · number

Number of reconnection attempts made.

retryTime · number

Estimated time of next reconnection attempt.

reason · string

If failed, description of why.

const status = Meteor.status();
console.log('Connected:', status.connected);
console.log('Status:', status.status);

// Reactive usage
Tracker.autorun(() => {
  const status = Meteor.status();
  if (status.connected) {
    console.log('Connected to server');
  }
});

Meteor.reconnect()

Force an immediate reconnection attempt if the client is not connected to the server.

Locus: Client

Meteor.reconnect();

Meteor.disconnect()

Disconnect the client from the server.

Locus: Client

Meteor.disconnect();

Reactive State

Meteor.loggingIn()

True if a login method is currently in progress. A reactive data source.

Locus: Client

if (Meteor.loggingIn()) {
  return <Spinner />;
}

Meteor.loggingOut()

True if a logout method is currently in progress. A reactive data source.

Locus: Client

if (Meteor.loggingOut()) {
  console.log('Logging out...');
}

Server Connection

Meteor.onConnection()

Register a callback to be called when a new DDP connection is made to the server.

Locus: Server

callback · function · required

The function to call when a new DDP connection is established.

Meteor.onConnection((connection) => {
  console.log('New connection:', connection.id);
  console.log('Client address:', connection.clientAddress);
  
  connection.onClose(() => {
    console.log('Connection closed:', connection.id);
  });
});