Guide
Examples
Plugins
Reference
Guide
Examples
Plugins
Reference

Examples

This section provides practical examples of using the Lix SDK for common scenarios.

Overview

Lix SDK can be used to build a variety of applications that benefit from change control. The examples in this section demonstrate how to:

  • Set up a basic Lix application
  • Work with different file formats
  • Manage versions and branches
  • Implement collaboration features
  • Build complete applications

Quick Example

Here's a simple example of using Lix SDK to track changes in a JSON file:

import { newLixFile, openLix } from "@lix-js/sdk";
import { plugin as jsonPlugin } from "@lix-js/plugin-json";

// Create and open a new Lix file
const lixFile = await newLixFile();
const lix = await openLix({
  blob: lixFile,
  providePlugins: [jsonPlugin],
});

// Insert a JSON file
const data = {
  name: "My Project",
  version: "1.0.0",
  settings: { theme: "dark", fontSize: 14 }
};

await lix.db
  .insertInto("file")
  .values({
    path: "/config.json",
    data: new TextEncoder().encode(JSON.stringify(data)),
  })
  .execute();

// Make a change
data.version = "1.1.0";
data.settings.fontSize = 16;

await lix.db
  .updateTable("file")
  .set({
    data: new TextEncoder().encode(JSON.stringify(data)),
  })
  .where("path", "=", "/config.json")
  .execute();

// View the changes
const changes = await lix.db
  .selectFrom("change")
  .innerJoin("file", "file.id", "change.file_id")
  .where("file.path", "=", "/config.json")
  .selectAll()
  .execute();

console.log("Changes:", changes);

Example Categories

The examples are organized into categories:

Each example includes:

  • Full code samples
  • Step-by-step explanations
  • Tips for best practices
  • Variations for different use cases

Live Examples

For interactive examples, visit our demo application to see Lix in action.

ON THIS PAGE