Skip to content

doc: clarify sqlite bare named parameter default#62009

Open
skdas20 wants to merge 1 commit intonodejs:mainfrom
skdas20:docs/sqlite-allow-bare-named-params-61823
Open

doc: clarify sqlite bare named parameter default#62009
skdas20 wants to merge 1 commit intonodejs:mainfrom
skdas20:docs/sqlite-allow-bare-named-params-61823

Conversation

@skdas20
Copy link

@skdas20 skdas20 commented Feb 26, 2026

Fixes #61823

Summary

Updates statement.setAllowBareNamedParameters() documentation to match the actual default behavior.

  • Replaced wording that implied prefixed named parameters are required by default.
  • Clarified that bare named parameters are allowed by default.
  • Clarified that this API toggles the behavior (enable/disable), and caveats apply when bare names are enabled.

Validation

Ran markdown lint on the changed file:

node tools/lint-md/lint-md.mjs doc/api/sqlite.md

Result: exit code 0.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/sqlite

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. sqlite Issues and PRs related to the SQLite subsystem. labels Feb 26, 2026
Copy link

@mike-git374 mike-git374 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve the PR and the wording is correct, but I suggest this 1 change. Then might need to re-lint

parameters. However, with the exception of dollar sign character, these
prefix characters also require extra quoting when used in object keys.
`node:sqlite` allows binding named parameters without this prefix character in
JavaScript code. With the exception of the dollar sign character, these prefix

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
JavaScript code. With the exception of the dollar sign character, these prefix
the parameter object. With the exception of the dollar sign character, these prefix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. sqlite Issues and PRs related to the SQLite subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: sqlite statement.setAllowBareNamedParameters()

3 participants