Skip to content

Commit 1d7d11c

Browse files
committed
Tidy up Error doc regarding Promises
1 parent 3b11f0e commit 1d7d11c

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

doc/api.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -214,17 +214,18 @@ Scripts to create Oracle's sample schemas can be found at
214214

215215
## <a name="errorobj"></a> 2. Errors
216216

217-
Unless otherwise specified, the last parameter of each method is a
218-
callback. If an application does not pass a callback function where
219-
it is expected, then node-oracledb throws an exception of type *Error*.
217+
The last parameter of each method is a callback, unless
218+
[Promises](#promiseoverview) are being used. The first parameter of
219+
the callback is an *Error* object that contains error information if
220+
the call fails. If the call succeeds, then the object is null.
220221

221-
The first parameter of the callback is an *Error* object that
222-
contains error information if the call fails. If the call succeeds,
223-
then the object is null.
222+
When using Promises, the `catch()` callback's error object will
223+
contain error information when the Promise chain fails.
224224

225-
If an invalid value is set for a property, then the *Error* object is
226-
thrown. The same is true for invalid operations on
227-
read-only or write-only properties.
225+
If an invalid value is set for a property, then an error occurs. The
226+
same is true for invalid operations on read-only or write-only
227+
properties. If an unrecognized property name is used, it will be
228+
ignored.
228229

229230
### <a name="properror"></a> 2.1 Error Properties
230231

0 commit comments

Comments
 (0)