Config | Keyvify Documentation

Keyvify Configuration (Common for all Dialects)

Example:

SQLite

const config = {
     dialect: "sqlite",
     storage: "./database.sqlite"
}

Postgres

const config = {
     dialect: "postgres",
     username: "someuser",
     password: "youshallnotpass",
     host: "localhost",
     port: "8080"
}

MongoDB

const config = {
     dialect: "mongodb",
     uri: "mongodb://mongodb0.example.com:27017"
}

Index

cache: BaseCache | false

Whether to disable caching

database: undefined | string

Database name

deserializer: undefined | ((input: string) => any)

Data deserializer

Can be a Dialect name or the instance of it. Refer all the Dialects here: SupportedDialectsType

host: undefined | string

Database's host

password: undefined | string

Password of the Database

port: undefined | number

Database's Port

serializer: undefined | ((input: any) => string)

Data serializer

storage: undefined | string

Path to Database file (only when using SQLite)

uri: undefined | string

MongoDB URL (only when using MongoDB)

username: undefined | string

Username of the Database