Initialize

How to get started with Dubnium.

const Dubnium = require('dubnium')
const db = new Dubnium('dirPath', options)
const db = new (require("dubnium"))("dir", options)
circle-info

You can initialize as many databases as you want

Parameters

Name
About
Type
Required

dir

The path to the directory to store Records.

String

options.ext

Custom file extension (default: json)

String

options

Options

Object

options.name

Database name

String

options.force

Enable force overwriting of a preexisting Record.

Boolean

options.versioning

Read more in Versioning.

Object

options.requireRoot

Functions to require root access to run

Array

options.trash

Dir to trash Records in

String

options.metadata

Set to false to disable metadata tracking

Bool

Last updated