Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
lodash-id mixin
✓ const _ = require('lodash');
_.mixin(require('lodash-id'));
✗ import { getById } from 'lodash-id';
lodash-id is designed as a CommonJS module to be mixed into the Lodash (or Underscore) `_` object, not as a direct ESM import for individual functions.
getById (and other methods)
✓ const post = _.getById(db.posts, 1);
✗ const { getById } = require('lodash-id');
const post = getById(db.posts, 1);
All functions provided by lodash-id become methods of the Lodash `_` object after `_.mixin` is called. They are not standalone exports.
id (custom ID property)
✓ _.id = '_id';
✗ lodashId.id = '_id';
The `id` property for customization is a direct property of the mixed-in Lodash `_` object, not an export of the module itself.
Demonstrates how to initialize lodash-id and perform basic CRUD operations like insert, get, update, upsert, and remove on an in-memory collection.
const _ = require('lodash');
_.mixin(require('lodash-id'));
const db = {
posts: [
{ id: 1, title: 'First Post', published: false },
{ id: 2, title: 'Second Post', published: true }
]
};
// Insert a new document
const newPost = _.insert(db.posts, { title: 'Third Post' });
console.log('Inserted post:', newPost); // { id: 3, title: 'Third Post' }
// Get a document by ID
const post1 = _.getById(db.posts, 1);
console.log('Got post by ID 1:', post1); // { id: 1, title: 'First Post', published: false }
// Update a document by ID
_.updateById(db.posts, newPost.id, { published: true });
console.log('Updated post:', _.getById(db.posts, newPost.id)); // { id: 3, title: 'Third Post', published: true }
// Upsert a document (replaces if ID exists, inserts if not)
_.upsert(db.posts, { id: 1, title: 'First Post Updated', category: 'News' });
console.log('Upserted post 1:', _.getById(db.posts, 1)); // { id: 1, title: 'First Post Updated', category: 'News' }
// Remove a document by ID
const removedPost = _.removeById(db.posts, 2);
console.log('Removed post by ID 2:', removedPost); // { id: 2, title: 'Second Post', published: true }
console.log('Remaining posts:', db.posts); // [{ id: 1, title: 'First Post Updated', category: 'News' }, { id: 3, title: 'Third Post', published: true }]
Debug
Known issues
breakingAs of v0.14.0, `lodash-id` no longer provides `localStorage` or `file` functions for data persistence. Users previously relying on these must now implement custom persistence logic or integrate with `lowdb` directly to handle data saving and loading.fixMigrate persistence logic to `lowdb` or implement custom `save` and `load` functions that interact with your storage mechanism (e.g., file system, database, browser storage).
affects: >=0.14.0
breakingThe behavior of the `insert` method changed significantly. In v0.8.0, `insert` would replace existing documents with the same ID. However, in current versions (post-v0.8.0, likely with the introduction of `upsert`), `insert` now throws an error if a document with the provided ID already exists in the collection. To replace documents, use the `upsert` method instead.fixIf you intend to replace a document when its ID already exists, use `_.upsert(collection, document)` instead of `_.insert(collection, document)`. If you strictly want to add only new documents and fail on duplicates, `_.insert` is appropriate.
affects: >=0.8.1 (or post-v0.8.0 change)
breakingThe `mixWith` function was removed in v0.7.0. Developers must now use `_.mixin` directly to integrate `lodash-id` functionalities into their Lodash instance.fixReplace any calls to `_.mixWith(require('lodash-id'))` with `_.mixin(require('lodash-id'))`. affects: >=0.7.0
gotchaSince v0.12.0, `lodash-id` normalizes IDs, treating string and integer representations of the same ID (e.g., `1` and `'1'`) as equivalent in methods like `getById`, `updateById`, and `removeById`. While this simplifies usage, it may lead to unexpected behavior if strict type-based ID comparisons were previously relied upon.fixBe aware of ID normalization when interacting with collections. Ensure your application logic accounts for this behavior and does not rely on strict type differences for IDs in `lodash-id` operations.
affects: >=0.12.0
gotchaBy default, `lodash-id` assumes the unique identifier property for documents is `id`. If your documents use a different property (e.g., `_id`, `uuid`), you must explicitly configure `lodash-id` to use that property.fixSet the `_.id` property to your custom ID key immediately after mixing in `lodash-id`: `_.id = '_id';`
affects: >=0.1.0
Errors
Common errors & fixes
TypeError: _.getById is not a function
The lodash-id mixin has not been properly applied to the Lodash instance.
fixEnsure you have called `_.mixin(require('lodash-id'))` after importing both `lodash` and `lodash-id`. Error: Document with id 'X' already exists.
You are attempting to use `_.insert` to add a document with an `id` that already exists in the collection.
fixIf you intend to replace the existing document, use `_.upsert(collection, document)` instead of `_.insert`. If you wish to only insert new unique documents, ensure the `id` is unique or generated dynamically (e.g., by letting `insert` create one if no ID is provided).
Data not saved/loaded after application restart or page refresh.
You might be expecting `lodash-id` to handle data persistence, but it only provides in-memory array manipulation. Furthermore, `localStorage` and `file` functions were removed in v0.14.0.
fixIntegrate your `lodash-id` usage with a dedicated persistence layer like `lowdb` (which is often used with `lodash-id`) or implement your own `save` and `load` mechanisms for the data collections.
Audit
Dependencies
lodashrequiredlodash-id extends Lodash's utility belt as a mixin. Required at runtime.
lowdboptionallodash-id can be used with lowdb for persistence, which typically bundles its own Lodash-like utilities or similar methods.