Class default

constructor

• new default(options?: { path: string } & Partial<DatabaseOptions>): default

• Database constructor.

  Parameters

  • Optionaloptions: { path: string } & Partial<DatabaseOptions>

    • path: string

      Database path

    • version

      Database version

    • path

      Database path

    • onUpgrade

      Triggered when the database is upgraded

    • onDowngrade

      Triggered when the database is downgraded

  Returns default

_models

Model

options

Schema

SchemaType

StaticSchema

StaticSchemaType

Staticversion

load

• load(callback?: NodeJSLikeCallback<any>): Bluebird<any>

• Loads database.

  Parameters

  • Optionalcallback: NodeJSLikeCallback<any>

  Returns Bluebird<any>

model

• model<T = any>(
      name: string,
      schema?: Record<string, AddSchemaTypeOptions> | default<T>,
  ): default<any>

• Creates a new model.

  Type Parameters

  • T = any

  Parameters

  • name: string
  • Optionalschema: Record<string, AddSchemaTypeOptions> | default<T>

  Returns default<any>

save

• save(callback?: NodeJSLikeCallback<any>): Bluebird<void>

• Saves database.

  Parameters

  • Optionalcallback: NodeJSLikeCallback<any>

  Returns Bluebird<void>

toJSON

• toJSON(): {
      meta: { version: number; warehouse: string };
      models: Record<string, default<any>>;
  }

• Returns {
      meta: { version: number; warehouse: string };
      models: Record<string, default<any>>;
  }