Documentation Index
Fetch the complete documentation index at: https://mintlify.com/estebanrfp/gdb/llms.txt
Use this file to discover all available pages before exploring further.
Installation
GenosDB can be installed via package managers or used directly in the browser from a CDN. Choose the method that works best for your project.
Package Manager Installation
Import in Your Project
After installation, import GenosDB using ES6 modules:
import { gdb } from 'genosdb';
// Initialize a database
const db = await gdb('my-app');
GenosDB uses an async factory function. You can use top-level await in modern ES modules or wrap the initialization in an async function.
CDN Usage
You can use GenosDB directly in the browser without any build tools:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>GenosDB Example</title>
</head>
<body>
<h1>GenosDB CDN Example</h1>
<script type="module">
import { gdb } from 'https://cdn.jsdelivr.net/npm/genosdb@latest/dist/index.min.js';
// Initialize database
const db = await gdb('my-app', { rtc: true });
// Store data
const id = await db.put({ message: 'Hello from CDN!' });
console.log('Stored with ID:', id);
</script>
</body>
</html>
CDN Options
GenosDB is available on multiple CDNs:
<script type="module">
import { gdb } from 'https://cdn.jsdelivr.net/npm/genosdb@latest/dist/index.min.js';
</script>
<script type="module">
import { gdb } from 'https://unpkg.com/genosdb@latest/dist/index.min.js';
</script>
Always use <script type="module"> when importing from CDN to enable ES6 module syntax.
Browser Compatibility
GenosDB works in all modern browsers that support:
- ES2020+ (async/await, optional chaining, etc.)
- OPFS (Origin Private File System) for persistent storage
- WebRTC for P2P communication (when using
rtc: true)
- IndexedDB as a fallback for browsers without OPFS support
Supported Browsers
Chrome / Edge
Version 86+ (full support with OPFS)
Firefox
Version 111+ (OPFS support added)
Safari
Version 15.2+ (partial OPFS support)
Mobile Browsers
iOS Safari 15.2+, Chrome Mobile 86+
For browsers without OPFS support, GenosDB automatically falls back to IndexedDB for storage.
WebAuthn Requirements
If you’re using the Security Manager module with WebAuthn authentication:
- HTTPS required in production
- localhost or 127.0.0.1 works for development
- Hardware security keys or biometric authentication must be available
Bundler Configuration
GenosDB works out-of-the-box with most bundlers, but here are some tips:
Vite
No special configuration needed:
import { defineConfig } from 'vite';
export default defineConfig({
// GenosDB works automatically
});
Webpack
For Webpack 5, ensure you’re targeting modern browsers:
module.exports = {
target: 'web',
output: {
module: true,
},
experiments: {
outputModule: true,
},
};
Next.js
For Next.js, mark GenosDB as a client-side only module:
module.exports = {
webpack: (config) => {
config.resolve.fallback = {
fs: false,
net: false,
tls: false,
};
return config;
},
};
import dynamic from 'next/dynamic';
const MyComponent = dynamic(
() => import('../components/GenosDBComponent'),
{ ssr: false }
);
TypeScript Support
GenosDB includes TypeScript type definitions. No additional setup needed:
import { gdb } from 'genosdb';
interface User {
name: string;
age: number;
}
const db = await gdb('my-app');
const userId = await db.put<User>({ name: 'Alice', age: 30 });
While GenosDB provides type definitions, the library itself is distributed as optimized, minified JavaScript for performance.
Verify Installation
Test your installation with this simple example:
import { gdb } from 'genosdb';
// Initialize database
const db = await gdb('test-db');
// Store a value
const id = await db.put({ message: 'Installation successful!' });
// Retrieve it
const { result } = await db.get(id);
console.log(result.value); // { message: 'Installation successful!' }
Next Steps
Learn Core Concepts
Understand how GenosDB works in the Concepts section Explore Examples
See working code in our Examples gallery Troubleshooting
Module not found
If you get a “module not found” error, ensure you’re using a modern bundler that supports ES modules.
OPFS not available
If you see warnings about OPFS, your browser may not support it. GenosDB will automatically fall back to IndexedDB.
WebRTC connection issues
If P2P connections fail, you may need to configure TURN servers for NAT traversal. See the P2P Setup Guide.
Need Help?
Check out our GitHub Discussions or open an issue.