Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.larksh.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Error handling

The Lark SDK uses a consistent error model. Every error thrown by the SDK is a LarkError instance with a machine-readable code and a human-readable message.

​
Error structure

import { LarkDatabase, LarkError } from "@lark-sh/client";

const db = new LarkDatabase("my-project/my-database", { anonymous: true });

try {
  await db.ref("admin/secret").set("hack");
} catch (error) {
  if (error instanceof LarkError) {
    console.log(error.code);    // "permission_denied"
    console.log(error.message); // "Permission denied at /admin/secret"
  }
}

​
Error codes

CodeDescription
permission_deniedSecurity rules rejected the operation. The authenticated user (or anonymous client) doesn’t have access to the requested path or operation.
invalid_dataThe data you tried to write is malformed. This includes invalid key characters, values that exceed size limits, or structurally invalid data.
not_foundThe requested path doesn’t exist. Returned by certain operations that expect existing data.
invalid_pathThe path string is malformed. Paths can’t contain ., #, $, [, or ] characters.
timeoutThe operation didn’t complete within the timeout window (30 seconds by default).
not_connectedYou attempted an operation that requires a connection while the client is disconnected.
condition_failedA transaction’s condition check failed. The data didn’t match the expected state.
max_retries_exceededA transaction was retried 25 times and still couldn’t commit due to contention.
write_taintedA write was rejected because it depended on a prior write that failed. This prevents cascading inconsistencies.
auth_requiredThe operation requires authentication, but the client is connected anonymously and security rules demand an authenticated user.

​
Handling write errors

All write operations (set, update, remove, push) return promises. Wrap them in try/catch: 
try {
  await db.ref("users/alice/score").set(100);
  console.log("Write succeeded");
} catch (error) {
  if (error instanceof LarkError) {
    switch (error.code) {
      case "permission_denied":
        console.error("You don't have permission to write here");
        break;
      case "invalid_data":
        console.error("Invalid data:", error.message);
        break;
      default:
        console.error("Write failed:", error.code, error.message);
    }
  }
}

​
Handling read errors

Read operations (once, get) can also fail: 
try {
  const snapshot = await db.ref("restricted/data").once("value");
  console.log(snapshot.val());
} catch (error) {
  if (error instanceof LarkError) {
    console.error("Read failed:", error.code, error.message);
  }
}

​
Handling transaction errors

Transactions can fail for additional reasons beyond normal write errors: 
try {
  await db.ref("counter").transaction((current) => (current ?? 0) + 1);
} catch (error) {
  if (error instanceof LarkError) {
    switch (error.code) {
      case "max_retries_exceeded":
        console.error("Too much contention, try again later");
        break;
      case "condition_failed":
        console.error("Precondition not met");
        break;
      default:
        console.error("Transaction failed:", error.code);
    }
  }
}

​
Connection-level errors

For errors that aren’t tied to a specific operation (transport failures, authentication errors, protocol issues), use db.onError(): 
db.onError((error) => {
  console.error("Connection error:", error.code, error.message);

  // You might want to show a notification to the user
  showErrorNotification(error.message);
});
db.onError() returns an unsubscribe function, just like other event listeners. Clean it up when you no longer need it.
const unsubscribe = db.onError((error) => {
  console.error(error);
});

// Later
unsubscribe();

​
Best practices

Always handle permission_denied errors in your UI. They usually mean a user is trying to access data they shouldn’t, either a bug in your security rules or a user navigating somewhere unexpected.
  • Wrap writes in try/catch. Even if you’re confident your security rules will allow the write, network issues or data validation can cause failures.
  • Log errors with their codes. The code field is stable and machine-readable. Use it for programmatic decisions. Use message for human-readable logging.
  • Use db.onError() as a safety net. It catches connection-level issues that individual operation error handling might miss.
  • Don’t swallow errors silently. At minimum, log them. Silently dropped errors make debugging much harder.