Class LayoutBuilder

A layout builder for the IKeyValueDatabase.

Implements

ILayoutBuilder

Index

Constructors

Properties

Methods

getLayout table layout validateLayout

Constructors

`Private` constructor

new LayoutBuilder(version): LayoutBuilder
Parameters
- version: number
Returns LayoutBuilder

Properties

`Private` layout

layout: IDatabaseLayout

Methods

getLayout

getLayout(): IDatabaseLayout
Gets the layout.

Returns IDatabaseLayout
The layout: IDatabaseLayout.

Implementation of ILayoutBuilder.getLayout

table

table(name): TableBuilder
Adds a table to the layout.
Parameters
- name: string
  The name of the table.
Returns TableBuilder
A table builder.

Implementation of ILayoutBuilder.table

`Static` layout

layout(version): LayoutBuilder
Creates a layout builder.
Parameters
- version: number
  The version of the layout.
Returns LayoutBuilder
A layout builder.

`Static` validateLayout

validateLayout(layout): [boolean, string]
Validates a layout.
Parameters
- layout: IDatabaseLayout
  The layout to validate.
Returns [boolean, string]
Whether the layout is valid, and a descriptive message.

Generated using TypeDoc