Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
RedisDocument
✓ import { RedisDocument } from 'modinha-redis'
✗ var RedisDocument = require('modinha-redis').RedisDocument
CommonJS require works if using default Node.js; switch to ESM import in modern setups.
default
✓ import modinhaRedis from 'modinha-redis'
✗ undefined
No default export; only named export RedisDocument exists.
RedisDocument
✓ const { RedisDocument } = require('modinha-redis')
✗ const RedisDocument = require('modinha-redis')
require returns an object with RedisDocument property, not the mixin directly.
Shows how to define a Modinha model with unique/secondary indexes, extend with RedisDocument mixin, insert a record, and use auto-generated query methods.
// npm install modinha modinha-redis redis
var Modinha = require('modinha');
var RedisDocument = require('modinha-redis').RedisDocument;
var Account = Modinha.define('accounts', {
email: { type: 'string', required: true, unique: true },
role: { type: 'string', secondary: true, enum: ['admin', 'editor', 'author'] },
hash: { type: 'string', private: true }
});
// Extend model with Redis persistence
Account.extend(RedisDocument);
// Insert a new account
Account.insert({ email: 'test@example.com', role: 'admin' }, function(err, result) {
if (err) console.error(err);
else console.log('Inserted:', result);
});
// List by role
Account.listByRole('admin', function(err, accounts) {
if (err) console.error(err);
else console.log('Admins:', accounts);
});
// Get by unique email
Account.getByEmail('test@example.com', function(err, account) {
if (err) console.error(err);
else console.log('Account:', account);
});
Errors
Common errors & fixes
TypeError: Account.extend is not a function
Account is not a Modinha model instance; missing Modinha.define() call.
fixEnsure Account = Modinha.define('accounts', { ... }) before extending. Error: Redis connection to 127.0.0.1:6379 failed - connect ECONNREFUSED
Redis server is not running or not accessible.
fixStart Redis server or set correct host/port via environment variables.
Cannot find module 'modinha-redis'
Package not installed or missing from node_modules.
fixRun: npm install modinha-redis
TypeError: Cannot destructure property 'RedisDocument' of '...' as it is undefined
Incorrect import module; e.g., var { RedisDocument } = require('modinha') instead of modinha-redis.
fixUse: const { RedisDocument } = require('modinha-redis'); Audit
Dependencies
modinharequiredRequired peer dependency; the mixin extends Modinha models.
redisrequiredRequired runtime dependency for Redis client.