Skip to main content
Version: 0.13

Variable: createError

const createError: object

Defined in: src/errors/index.ts:618

Create standardized error instances

Type Declaration​

config​

config: object

config.invalidFormat()​

invalidFormat: (field, format) => ConfigurationError

Parameters​
field​

string

format​

string

Returns​

ConfigurationError

config.invalidValue()​

invalidValue: (field, value, expected) => ConfigurationError

Parameters​
field​

string

value​

string

expected​

string

Returns​

ConfigurationError

config.missingRequired()​

missingRequired: (field) => ConfigurationError

Parameters​
field​

string

Returns​

ConfigurationError

connection​

connection: object

connection.authFailed()​

authFailed: (host) => ConnectionError

Parameters​
host​

string

Returns​

ConnectionError

connection.databaseNotFound()​

databaseNotFound: (database, host) => ConnectionError

Parameters​
database​

string

host​

string

Returns​

ConnectionError

connection.hostUnreachable()​

hostUnreachable: (host, port?) => ConnectionError

Parameters​
host​

string

port?​

number

Returns​

ConnectionError

metadata​

metadata: object

metadata.connectionFailed()​

connectionFailed: (originalError?) => MetadataStorageError

Parameters​
originalError?​

Error

Returns​

MetadataStorageError

metadata.getHistoricalDataFailed()​

getHistoricalDataFailed: (ruleId, days, originalError?) => MetadataStorageError

Parameters​
ruleId​

string

days​

number

originalError?​

Error

Returns​

MetadataStorageError

metadata.getRuleFailed()​

getRuleFailed: (ruleId, originalError?) => MetadataStorageError

Parameters​
ruleId​

string

originalError?​

Error

Returns​

MetadataStorageError

metadata.initializationFailed()​

initializationFailed: (reason?) => MetadataStorageError

Parameters​
reason?​

string

Returns​

MetadataStorageError

metadata.migrationFailed()​

migrationFailed: (version?, originalError?) => MetadataStorageError

Parameters​
version?​

string

originalError?​

Error

Returns​

MetadataStorageError

metadata.saveExecutionFailed()​

saveExecutionFailed: (ruleId, originalError?) => MetadataStorageError

Parameters​
ruleId​

string

originalError?​

Error

Returns​

MetadataStorageError

metadata.saveRuleFailed()​

saveRuleFailed: (ruleId, originalError?) => MetadataStorageError

Parameters​
ruleId​

string

originalError?​

Error

Returns​

MetadataStorageError

monitoring​

monitoring: object

monitoring.freshnessCheckFailed()​

freshnessCheckFailed: (table, reason) => MonitoringError

Parameters​
table​

string

reason​

string

Returns​

MonitoringError

monitoring.volumeCheckFailed()​

volumeCheckFailed: (table, reason) => MonitoringError

Parameters​
table​

string

reason​

string

Returns​

MonitoringError

query​

query: object

query.columnNotFound()​

columnNotFound: (column, table) => QueryError

Parameters​
column​

string

table​

string

Returns​

QueryError

query.resultTooLarge()​

resultTooLarge: (maxRows, table?) => QueryError

Parameters​
maxRows​

number

table?​

string

Returns​

QueryError

query.tableNotFound()​

tableNotFound: (table) => QueryError

Parameters​
table​

string

Returns​

QueryError

security​

security: object

security.blockedQuery()​

blockedQuery: (keyword) => SecurityError

Parameters​
keyword​

string

Returns​

SecurityError

security.invalidIdentifier()​

invalidIdentifier: (name) => SecurityError

Parameters​
name​

string

Returns​

SecurityError

security.queryNotAllowed()​

queryNotAllowed: () => SecurityError

Returns​

SecurityError

security.sslRequired()​

sslRequired: () => SecurityError

Returns​

SecurityError

timeout​

timeout: object

timeout.connection()​

connection: (timeoutMs) => TimeoutError

Parameters​
timeoutMs​

number

Returns​

TimeoutError

timeout.query()​

query: (timeoutMs) => TimeoutError

Parameters​
timeoutMs​

number

Returns​

TimeoutError