sql-escape-string
Simple SQL string escape.
const escapeString = const sqlString = "Sup'er"console // => Sup''er
Installation
npm install sql-escape-string
Note
Original implementation from sqlstring with the added option of supporting or not supporting backslash.
API
escapeString
Escapes the given string to protect against SQL injection attacks.
By default it assumes that backslashes are not supported as they are not part of the standard SQL spec. Quoting from the SQLlite web site:
C-style escapes using the backslash character are not supported because they are not standard SQL.
This means three things:
- backslashes and double quotes
"
are not escaped by default - single quotes are escaped via
''
instead of\'
- your sql engine should throw an error when encountering a backslash escape
as part of a string, unless it is a literal backslash, i.e.
'backslash: \\'
.
It is recommended to set the backslashSupported
option true
if your SQL
engine supports it. In that case backslash sequences are escaped and single
and double quotes are escaped via a backslash, i.e. '\''
.
Parameters
val
String the original string to be used in a SQL query$0
Object opts$0.backslashSupported
Boolean? iftrue
backslashes are supported (optional, defaultfalse
)
opts
Returns String the original string escaped wrapped in single quotes, i.e. 'mystring'
License
MIT