Inspector API

The Zero instance provides an API to gather information about the client's current state, such as:

• All active queries
• Query TTL
• Active clients
• Client database contents

This can help figuring out why you hit loading states, how many queries are active at a time, if you have any resource leaks due to failing to clean up queries or if expected data is missing on the client.

Creating an Inspector

Each Zero instance has an inspect method that will return the inspector.

Copyconst z = new Zero({
  /*your zero options*/
});
const inspector = await z.inspect();

Once you have an inspector you can inspect the current client and client group.

For example to see active queries for the current client:

Copyconsole.table(await inspector.client.queries());

To inspect other clients within the group:

Copyconst allClients = await inspector.clients();

Dumping Data

In addition to information about queries, you can see the contents of the client side database.

Copyconst inspector = await zero.inspect();
const client = inspector.client;

// All raw k/v data currently synced to client
console.log('client map:');
console.log(await client.map());

// kv table extracted into tables
// This is same info that is in z.query[tableName].run()
for (const tableName of Object.keys(schema.tables)) {
  console.log(`table ${tableName}:`);
  console.table(await client.rows(tableName));
}