Skip to content

Commit a40fdc3

Browse files
committed
minor documentation updates
1 parent 52a9bdd commit a40fdc3

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -237,11 +237,11 @@ 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>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or undefined if no rows were returned) |
241-
| mode | enum? | Optional row mode; can be one of the following values: [`object`, `array`]; default is `object`. When `mode=object`, each row will be returned as an object with property keys being field names; when `mode=array` each row will be returned as an array of values (without the field names) |
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). |
241+
| 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 |
243-
| params | object? | Optional query parameters to apply to to the query (see [parametarization](#parmetrized-queries))
244-
| handler | <[ResultHandler](#result-parsing)> | Optional result handler to apply custom parsing logic |
243+
| params | object? | Optional parameters to apply to to the query (see [parameterized queries](#parameterized-queries))
244+
| handler | object? | Optional result handler to apply custom parsing logic (see [result parsing](#result-parsing) ) |
245245
246246
A few examples of executing different queries:
247247
@@ -303,7 +303,7 @@ session.execute([query4, query5]).then((result) => {
303303
var user2 = result.get(query5.name);
304304
});
305305
```
306-
#### Parametrized Queries
306+
#### Parameterized Queries
307307
308308
Queries can be parametrized using named parameters. Parameters must be enclosed in `{{}}` brackets and `params` object should be provided with parameter values.
309309

bin/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -237,11 +237,11 @@ 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>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or undefined if no rows were returned) |
241-
| mode | enum? | Optional row mode; can be one of the following values: [`object`, `array`]; default is `object`. When `mode=object`, each row will be returned as an object with property keys being field names; when `mode=array` each row will be returned as an array of values (without the field names) |
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). |
241+
| 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 |
243-
| params | object? | Optional query parameters to apply to to the query (see [parametarization](#parmetrized-queries))
244-
| handler | <[ResultHandler](#result-parsing)> | Optional result handler to apply custom parsing logic |
243+
| params | object? | Optional parameters to apply to to the query (see [parameterized queries](#parameterized-queries))
244+
| handler | object? | Optional result handler to apply custom parsing logic (see [result parsing](#result-parsing) ) |
245245
246246
A few examples of executing different queries:
247247
@@ -303,7 +303,7 @@ session.execute([query4, query5]).then((result) => {
303303
var user2 = result.get(query5.name);
304304
});
305305
```
306-
#### Parametrized Queries
306+
#### Parameterized Queries
307307
308308
Queries can be parametrized using named parameters. Parameters must be enclosed in `{{}}` brackets and `params` object should be provided with parameter values.
309309

0 commit comments

Comments
 (0)