PgError.js is an error class for Node.js that parses PostgreSQL's
ErrorResponse format and names its fields with human readable
properties. It's most useful when combined with Brian Carlson's
Node.js PostgreSQL client library to get structured and
identifiable PostgreSQL errors. Supports all fields returned by PostgreSQL
up to v9.4.
The PostgreSQL client library does return an Error object with some fields
set, but it's not a dedicated object for easy instanceof identification nor
does it yet support all field types. I've found it immensely useful to be
strict and classify errors beforehand when building fault tolerant systems. That
helps programmatically decide whether to wrap, escalate or handle a particular
error.
Installing
npm install pg-error
PgError.js follows semantic versioning, so feel free to
depend on its major version with something like >= 1.0.0 < 2 (a.k.a ^1.0.0).
Using
var PgError = require("pg-error")var error = new PgError({ M: "null value in column \"name\" violates not-null constraint", S: "ERROR", C: "23502"})error instanceof PgError // => trueerror instanceof Error // => trueerror.message // => "null value in column \"name\" violates not-null constraint"error.severity // => "ERROR"error.code // => 23502
var msg = new Buffer("MWash your teeth!\0SWARNING\0\0")var error = PgError.parse(msg)error.message // => "Wash your teeth!"error.severity // => "WARNING"
However, the way the client is built, it will start emitting those errors and
notices under the PgError event name. Until that's improved in the
Pg.Connection class, you'll need to re-emit those under the correct error
and notice events:
function emitPgError(err) { switch (err.severity) { case "ERROR": case "FATAL": case "PANIC": return this.emit("error", err) default: return this.emit("notice", err) }}connection.on("PgError", emitPgError)
That's it. Your Pg query errors should now be instances of PgError and with
all the human readable field names.
Using PgError.js with Knex.js is similar to using it with the plain Node.js PostgreSQL client library described above. Because Knex.js has a connection pool, you'll have to hook PgError.js in on every newly created connection: