TaffyDB In-Memory JavaScript Database

Common errors

• TypeError: taffy is not a function

  cause Attempting to call `require('taffy')` directly as a function in Node.js.
  fix You need to access the `taffy` property from the required object: `const TAFFY = require('taffy').taffy;`

• SyntaxError: Cannot use import statement outside a module

  cause Attempting to use `import TAFFY from 'taffy';` in a CommonJS-only or non-module context.
  fix TaffyDB does not provide an ESM export. Use `const TAFFY = require('taffy').taffy;` in Node.js or load it via a `<script>` tag in the browser and use the global `TAFFY` variable.

• TAFFY is not defined

  cause Trying to use `TAFFY` in a browser environment without including the `taffy.js` script or before the script has loaded.
  fix Ensure you have `<script src="path/to/taffy.js"></script>` in your HTML before attempting to use the `TAFFY` global function.

Warnings

• gotcha When using TaffyDB in Node.js, you must specifically access the `taffy` function from the `require('taffy')` object (e.g., `require('taffy').taffy`). Requiring the package directly without `.taffy` will not return the database constructor.
  Fix: Change `const TAFFY = require('taffy');` to `const TAFFY = require('taffy').taffy;`
• gotcha TaffyDB is a legacy library that does not provide native ES Module (ESM) exports. Attempting to use `import TAFFY from 'taffy';` or similar ESM syntax will result in errors in modern JavaScript environments that enforce ESM.
  Fix: For Node.js, use `const TAFFY = require('taffy').taffy;`. For browser environments, load `taffy.js` via a `<script>` tag and use the global `TAFFY` variable.
• gotcha TaffyDB is an in-memory database, meaning all data is stored in the application's RAM. It does not provide persistence out-of-the-box. If the application restarts or the browser tab is closed, all data will be lost unless manually saved and loaded.
  Fix: Implement manual data persistence by serializing the database content (e.g., `db().get()`) to local storage, IndexedDB, or a server, and then re-initializing the database upon application startup.
• gotcha The documentation mentions compatibility with Node.js 0.10+. While the library is stable, its support for modern Node.js features (e.g., async/await, streams, newer event loop patterns) may be limited, and it might not be actively tested against the latest Node.js LTS versions.
  Fix: Thoroughly test TaffyDB's behavior in your specific modern Node.js environment before deploying to production. Consider alternative, more actively maintained in-memory database solutions for new projects if deep modern Node.js integration is required.

Install

• npm install taffydb npm
• yarn add taffydb yarn
• pnpm add taffydb pnpm

Imports

• TAFFY
  wrong:

  const TAFFY = require('taffy');

  correct:

  const TAFFY = require('taffy').taffy;

  In Node.js, the main export of the 'taffy' package is an object containing the 'taffy' function. You must access it via `.taffy` to get the database constructor. In browsers, `TAFFY` is typically exposed as a global variable.
• TAFFY
  wrong:

  import TAFFY from 'taffy';

  correct:

  <!-- Add <script src="taffy.js"></script> in HTML -->
  // TAFFY is now a global function

  TaffyDB is designed for CommonJS or global browser usage. There is no official ESM export, so direct `import` statements for `TAFFY` will fail. For browser usage, include the script tag and access the global `TAFFY`.

Quickstart

This quickstart demonstrates how to initialize a TaffyDB instance with JSON data, perform basic queries using SQL-like syntax (e.g., less than), update records, and select specific fields.

const TAFFY = require('taffy').taffy;

const product_db = TAFFY([
  {
    "item": 1,
    "name": "Blue Ray Player",
    "price": 99.99
  },
  {
    "item": 2,
    "name": "3D TV",
    "price": 1799.99
  },
  {
    "item": 3,
    "name": "Soundbar",
    "price": 149.99
  }
]);

console.log('All products:', product_db().get());

// Query for items with price less than 150
const lowPricedItems = product_db({price: {lt: 150}}).get();
console.log('Low priced items (price < 150):', lowPricedItems);

// Update the price of an item
product_db({item: 1}).update({price: 89.99});
console.log('Updated Blue Ray Player:', product_db({item: 1}).first());

// Select only names
const productNames = product_db().select("name");
console.log('Product names:', productNames);