Class ZDatabaseOptionsBuilder

Represents an object that can be used to build a database options object.

Index

Constructors

Properties

Methods

assign build copy database timeout url

Constructors

constructor

new ZDatabaseOptionsBuilder(): ZDatabaseOptionsBuilder
Initializes a new instance of this object.

Returns ZDatabaseOptionsBuilder
- Defined in options/database-options.ts:28

Properties

`Private` _options

_options: IZDatabaseOptions

Methods

assign

assign(other): ZDatabaseOptionsBuilder
Assigns values from a subset of database options to this object.
Parameters
- other: Partial<IZDatabaseOptions>
  The partial object to assign values from.
Returns ZDatabaseOptionsBuilder
This object.
- Defined in options/database-options.ts:83

build

build(): IZDatabaseOptions
Builds the options.

Returns IZDatabaseOptions
A copy of the current options structure.
- Defined in options/database-options.ts:108

copy

copy(other): ZDatabaseOptionsBuilder
Copies values from another database options structure to this object.
Parameters
- other: IZDatabaseOptions
  The object to copy.
Returns ZDatabaseOptionsBuilder
This object.
- Defined in options/database-options.ts:97

database

database(val): ZDatabaseOptionsBuilder
Sets the database to connect to.
Parameters
- val: string
  The value to set.
Returns ZDatabaseOptionsBuilder
This object.
- Defined in options/database-options.ts:41

timeout

timeout(val): ZDatabaseOptionsBuilder
Sets the timeout.
Parameters
- val: number
  The value to set.
Returns ZDatabaseOptionsBuilder
This object.
- Defined in options/database-options.ts:69

url

url(val): ZDatabaseOptionsBuilder
Sets the connection string.
Parameters
- val: string
  The connection string.
Returns ZDatabaseOptionsBuilder
This object.
- Defined in options/database-options.ts:55

Generated using TypeDoc