Skip to content

docs: fix various documentation typos and issues #1721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
arthurschreiber wants to merge 2 commits into
base: master
Choose a base branch
from
+27 −27
Draft

docs: fix various documentation typos and issues #1721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bedcc1b
docs: fix typos, grammar, and inconsistencies in inline documentation
claude Dec 20, 2025
3f40278
Merge branch 'master' into claude/improve-documentation-Fynhu
arthurschreiber Dec 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions src/connection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,10 @@ interface AzureActiveDirectoryMsiAppServiceAuthentication {
type: 'azure-active-directory-msi-app-service';
options: {
/**
* If you user want to connect to an Azure app service using a specific client account
* they need to provide `clientId` associate to their created identity.
* If you want to connect to an Azure app service using a specific client account,
* you need to provide the `clientId` associated with your created identity.
*
* This is optional for retrieve token from azure web app service
* This is optional for retrieving a token from Azure web app service.
*/
clientId?: string;
};
Expand All @@ -214,10 +214,10 @@ interface AzureActiveDirectoryMsiVmAuthentication {
type: 'azure-active-directory-msi-vm';
options: {
/**
* If you want to connect using a specific client account
* they need to provide `clientId` associated to their created identity.
* If you want to connect using a specific client account,
* you need to provide the `clientId` associated with your created identity.
*
* This is optional for retrieve a token
* This is optional for retrieving a token.
*/
clientId?: string;
};
Expand All @@ -227,10 +227,10 @@ interface AzureActiveDirectoryDefaultAuthentication {
type: 'azure-active-directory-default';
options: {
/**
* If you want to connect using a specific client account
* they need to provide `clientId` associated to their created identity.
* If you want to connect using a specific client account,
* you need to provide the `clientId` associated with your created identity.
*
* This is optional for retrieving a token
* This is optional for retrieving a token.
*/
clientId?: string;
};
Expand All @@ -241,8 +241,8 @@ interface AzureActiveDirectoryAccessTokenAuthentication {
type: 'azure-active-directory-access-token';
options: {
/**
* A user need to provide `token` which they retrieved else where
* to forming the connection.
* A user needs to provide a `token` which they retrieved elsewhere
* to form the connection.
*/
token: string;
};
Expand All @@ -252,12 +252,12 @@ interface AzureActiveDirectoryPasswordAuthentication {
type: 'azure-active-directory-password';
options: {
/**
* A user need to provide `userName` associate to their account.
* A user needs to provide a `userName` associated with their account.
*/
userName: string;

/**
* A user need to provide `password` associate to their account.
* A user needs to provide a `password` associated with their account.
*/
password: string;

Expand Down Expand Up @@ -573,13 +573,13 @@ export interface ConnectionOptions {
* * `SERIALIZABLE`
* * `SNAPSHOT`
*
* (default: `READ_COMMITED`).
* (default: `READ_COMMITTED`).
*/
connectionIsolationLevel?: number;

/**
* When encryption is used, an object may be supplied that will be used
* for the first argument when calling [`tls.createSecurePair`](http://nodejs.org/docs/latest/api/tls.html#tls_tls_createsecurepair_credentials_isserver_requestcert_rejectunauthorized)
* for the first argument when calling [`tls.createSecureContext`](https://nodejs.org/docs/latest/api/tls.html#tlscreatesecurecontextoptions).
*
* (default: `{}`)
*/
Expand Down Expand Up @@ -667,7 +667,7 @@ export interface ConnectionOptions {
enableImplicitTransactions?: boolean;

/**
* If false, error is not generated during loss of precession.
* If false, error is not generated during loss of precision.
*
* (default: `false`)
*/
Expand Down Expand Up @@ -718,7 +718,7 @@ export interface ConnectionOptions {
* * `SERIALIZABLE`
* * `SNAPSHOT`
*
* (default: `READ_COMMITED`).
* (default: `READ_COMMITTED`).
*/
isolationLevel?: number;

Expand All @@ -742,7 +742,7 @@ export interface ConnectionOptions {
lowerCaseGuids?: boolean;

/**
* The maximum number of connection retries for transient errors.、
* The maximum number of connection retries for transient errors.
*
* (default: `3`).
*/
Expand Down Expand Up @@ -2626,10 +2626,10 @@ class Connection extends EventEmitter {

/**
* Execute the SQL batch represented by [[Request]].
* There is no param support, and unlike [[Request.execSql]],
* There is no param support, and unlike [[execSql]],
* it is not likely that SQL Server will reuse the execution plan it generates for the SQL.
*
* In almost all cases, [[Request.execSql]] will be a better choice.
* In almost all cases, [[execSql]] will be a better choice.
*
* @param request A [[Request]] object representing the request.
*/
Expand Down
6 changes: 3 additions & 3 deletions src/data-type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ export const TYPE = {
*
* <tbody>
* <tr class="group-heading">
* <th colspan="4">Date and Time</th>
* <th colspan="5">Date and Time</th>
* </tr>
* <tr>
* <td><code>smalldatetime</code></td>
Expand Down Expand Up @@ -282,7 +282,7 @@ export const TYPE = {
*
* <tbody>
* <tr class="group-heading">
* <th colspan="4">Character Strings</th>
* <th colspan="5">Character Strings</th>
* </tr>
* <tr>
* <td><code>char</code></td>
Expand All @@ -309,7 +309,7 @@ export const TYPE = {
*
* <tbody>
* <tr class="group-heading">
* <th colspan="4">Unicode Strings</th>
* <th colspan="5">Unicode Strings</th>
* </tr>
* <tr>
* <td><code>nchar</code></td>
Expand Down
8 changes: 4 additions & 4 deletions src/request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ interface RequestOptions {
/**
* ```js
* const { Request } = require('tedious');
* const request = new Request("select 42, 'hello world'", (err, rowCount) {
* const request = new Request("select 42, 'hello world'", (err, rowCount) => {
* // Request completion callback...
* });
* connection.execSql(request);
Expand Down Expand Up @@ -154,7 +154,7 @@ class Request extends EventEmitter {
listener:
/**
* An array or object (depends on [[ConnectionOptions.useColumnNames]]), where the columns can be accessed by index/name.
* Each column has two properties, `metadata` and `value`：
* Each column has two properties, `metadata` and `value`:
*
* * `metadata`
*
Expand Down Expand Up @@ -258,7 +258,7 @@ class Request extends EventEmitter {
* The parameter's output value.
*
* @param metadata
* The same data that is exposed in the `columnMetaData` event.
* The same data that is exposed in the `columnMetadata` event.
*/
(parameterName: string, value: unknown, metadata: Metadata) => void
): this
Expand Down Expand Up @@ -469,7 +469,7 @@ class Request extends EventEmitter {
}

/**
* Temporarily suspends the flow of data from the database. No more `row` events will be emitted until [[resume] is called.
* Temporarily suspends the flow of data from the database. No more `row` events will be emitted until [[resume]] is called.
* If this request is already in a paused state, calling [[pause]] has no effect.
*/
pause() {
Expand Down
Loading