docs: fix README accuracy and add missing documentation#1845
Merged
dhensby merged 8 commits intotediousjs:masterfrom Apr 16, 2026
Merged
docs: fix README accuracy and add missing documentation#1845dhensby merged 8 commits intotediousjs:masterfrom
dhensby merged 8 commits intotediousjs:masterfrom
Conversation
The `multiple: true` directive was removed in the 3.x to 4.x migration (also documented in the changelog section of the README). Remove the reference from the batch API section as it is misleading. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The MSNodeSQLv8 section stated "requires Node.js v10+ or newer" which is outdated. The minimum Node.js version is defined by the package engines field. Remove the hardcoded version to avoid it going stale. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Document how the library automatically selects the SQL type when a Number or bigint value is provided without an explicit type parameter: integers within 32-bit range map to sql.Int, larger integers to sql.BigInt, and non-integer numbers to sql.Float. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the project’s README to better reflect the current node-mssql API and supported environment, removing stale/obsolete documentation and adding missing API reference details.
Changes:
- Removes outdated references (Appveyor/Gitter badges, SQL Server 2000 workarounds,
request.multiple, hardcoded MSNodeSQLv8 Node version). - Adds missing API documentation for ConnectionPool introspection (
healthy,size, etc.) andConnectionPool.parseConnectionString(). - Documents automatic numeric type inference and adds an “11.x to 12.x changes” migration entry.
dhensby
force-pushed
the
docs/readme-accuracy
branch
from
7a63b87 to
f9c781d
Compare
These methods exist in the Request class but were only mentioned in the 5.x to 6.x changelog. Add proper API documentation in the Request section with arguments, examples, and table of contents entries. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add documentation for pool introspection properties (healthy, size, available, pending, borrowed, connected, connecting) and the static parseConnectionString method. These were previously only mentioned in changelog entries. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Remove the Known Issues section which only contained SQL Server 2000 workarounds (end-of-life July 2013). Also remove the SQL Server 2000 reference from the batch section description. These are no longer relevant with current tedious versions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add missing changelog entry for the 11.x to 12.x migration, which includes the removal of config object cloning (breaking change), tedious 19 upgrade, and rfdc removal. Also add missing 10.x and 9.x changelog entries to the table of contents. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
CI has moved to GitHub Actions and Gitter is no longer active. Remove the Appveyor CI badge, Gitter chat badge, and unused david-dm link references. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
dhensby
force-pushed
the
docs/readme-accuracy
branch
from
f9c781d to
09c1e64
Compare
|
🎉 This PR is included in version 12.3.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Audit the README against the actual codebase and fix inaccuracies, remove stale content, and add missing API documentation.
Changes (each an atomic commit)
Remove stale
request.multiplereference — themultiple: truedirective was removed in 3.x→4.x but was still referenced in the batch section.Remove outdated Node.js version from MSNodeSQLv8 section — stated "requires Node.js v10+" which is outdated. Removed the hardcoded version since the minimum is defined by the package engines field.
Document auto type inference —
Numbervalues are auto-detected assql.Int,sql.BigInt, orsql.Floatbased on their value. JavaScriptbigintprimitives are also supported but were undocumented.Document
replaceInputandreplaceOutputmethods — these Request methods existed in code but were only mentioned in the 5.x→6.x changelog, not in the API reference.Document ConnectionPool properties and
parseConnectionString— pool introspection properties (healthy,size,available,pending,borrowed,connected,connecting) and the staticparseConnectionString()method were only mentioned in changelogs.Remove obsolete SQL Server 2000 references — the Known Issues section only contained SQL Server 2000 workarounds (EOL 2013). Also cleaned up a stale SQL Server 2000 reference in the batch section.
Add 11.x to 12.x changelog — this migration entry was missing. Documents the breaking change (config objects no longer cloned), tedious 19 upgrade, and rfdc removal.
Remove stale badges — Appveyor CI (CI moved to GitHub Actions) and Gitter chat badges, plus unused david-dm link references.