From 9d61428e7faa69928e629d28e1f4ed903f2137e1 Mon Sep 17 00:00:00 2001 From: M MacKinnon Date: Sat, 2 Sep 2023 20:30:12 +0200 Subject: [PATCH] fix result code type in SQliteError documentation (#1009) Fixes https://github.com/WiseLibs/better-sqlite3/issues/1007 --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 8c074d1a..a5da1f53 100644 --- a/docs/api.md +++ b/docs/api.md @@ -604,7 +604,7 @@ console.log(cat.name); // => "Joey" # class *SqliteError* -Whenever an error occurs within SQLite3, a `SqliteError` object will be thrown. `SqliteError` is a subclass of `Error`. Every `SqliteError` object has a `code` property, which is a string matching one of error codes defined [here](https://sqlite.org/rescode.html) (for example, `"SQLITE_CONSTRAINT"`). +Whenever an error occurs within SQLite3, a `SqliteError` object will be thrown. `SqliteError` is a subclass of `Error`. Every `SqliteError` object has a `code` property, which is a string matching one of the "extended result codes" defined [here](https://sqlite.org/rescode.html) (for example, `"SQLITE_CONSTRAINT_UNIQUE"`). If you receive a `SqliteError`, it probably means you're using SQLite3 incorrectly. The error didn't originate in `better-sqlite3`, so it's probably not an issue with `better-sqlite3`. It's recommended that you learn about the meaning of the error [here](https://sqlite.org/rescode.html), and perhaps learn more about how to use SQLite3 by reading [their docs](https://sqlite.org/docs.html).