Skip to content

Commit f4768f2

Browse files
committed
minor documentation update
1 parent a40fdc3 commit f4768f2

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ The only required property for a query is `text`, however, the behavior of the `
237237
| Property | Type | Description |
238238
| ------- | ------- | ----------- |
239239
| text | string | SQL code to be executed against the database |
240-
| mask | enum? | Optional result mask; can be one of the following values: [`list`, `single`]. If `mask` is not provided, no results will be returned to the caller (even for SELECT statements).<br/><br/>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/><br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or undefined if no rows were returned). |
240+
| mask | enum? | Optional result mask; can be one of the following values: [`list`, `single`]. If `mask` is not provided, no results will be returned to the caller (even for SELECT statements).<br/><br/>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/><br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or `undefined` if no rows were returned). |
241241
| mode | enum? | Optional row mode; can be one of the following values: [`object`, `array`]; default is `object`.<br/><br/>When `mode=object`, each row will be returned as an object with property keys being field names.<br/><br/>When `mode=array` each row will be returned as an array of values (without the field names). |
242242
| name | string? | Optional query name; used for logging. Also, when `execute()` is called with an array of queries, the returned map of results will be indexed by query name. For queries which don't have a name, the results will be held under the `undefined` key. If several executed queries have the same name, an array of results will be stored under the key for that name |
243243
| params | object? | Optional parameters to apply to to the query (see [parameterized queries](#parameterized-queries))

bin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ The only required property for a query is `text`, however, the behavior of the `
237237
| Property | Type | Description |
238238
| ------- | ------- | ----------- |
239239
| text | string | SQL code to be executed against the database |
240-
| mask | enum? | Optional result mask; can be one of the following values: [`list`, `single`]. If `mask` is not provided, no results will be returned to the caller (even for SELECT statements).<br/><br/>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/><br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or undefined if no rows were returned). |
240+
| mask | enum? | Optional result mask; can be one of the following values: [`list`, `single`]. If `mask` is not provided, no results will be returned to the caller (even for SELECT statements).<br/><br/>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/><br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or `undefined` if no rows were returned). |
241241
| mode | enum? | Optional row mode; can be one of the following values: [`object`, `array`]; default is `object`.<br/><br/>When `mode=object`, each row will be returned as an object with property keys being field names.<br/><br/>When `mode=array` each row will be returned as an array of values (without the field names). |
242242
| name | string? | Optional query name; used for logging. Also, when `execute()` is called with an array of queries, the returned map of results will be indexed by query name. For queries which don't have a name, the results will be held under the `undefined` key. If several executed queries have the same name, an array of results will be stored under the key for that name |
243243
| params | object? | Optional parameters to apply to to the query (see [parameterized queries](#parameterized-queries))

0 commit comments

Comments
 (0)