asSqlValue

与えられた値をSQLの値リテラルを表す文字列に変換します。

構文

asSqlValue(rawValue) => string
asSqlValue(rawValue, { useSingleQuote }) => string
asSqlValue(rawValue, { booleanReplacer }) => string
asSqlValue(rawValue, { useSingleQuote, booleanReplacer }) => string

引数

• rawValue: object | number | boolean | string | bigint | null | undefined

  SQLの値リテラルへ変換するデータです。

• options: object | undefined （省略可）

  以下のプロパティを持つオブジェクトです：

  • useSingleQuote: boolean | undefined （省略可）

    引用符が必要な識別子に単引用符（"）を使うかどうかです。

    true なら単引用符を使い、false なら二重引用符（"）を使います。

    このプロパティの指定は任意です。指定がない場合、単引用符を使います（true）。

  • booleanReplacer: function | undefined （省略可）

    論理値を変換するための関数です。

    この関数は単一の論理値を引数に取り、文字列を返さなければなりません。

    このプロパティの指定は任意です。指定がない場合、論理値はそれぞれ "TRUE" および "FALSE" に変換されます。

返値: string

変換結果の文字列です。

引数 rawValue が文字列の場合、結果は asSqlString() と同じです。 引数 options のプロパティ useSingleQuote が指定されていれば、それが asSqlString() の引数に使用されます。

引数 rawValue が数値の場合、十進数値リテラルに変換した結果を返します。

引数 rawValue がオブジェクトの場合、JSON 文字列へ変換された上で asSqlString() によって文字列リテラルとして変換された結果が返ります。 引数 options のプロパティ useSingleQuote が指定されていれば、それが asSqlString() の引数に使用されます。

引数 rawValue が論理値の場合、引数 booleanReplacer の結果を返します。

引数 rawValue が null または undefined なら "NULL" を返します。

例外

• TypeError
  • 引数 rawValue として変換できない型の値が与えられた場合
    • rawValue が function 型
    • rawValue が symbol 型

解説

与えられた値をSQLの値リテラルを表す文字列に変換します。

SQL文の中で何らかの値を要求する箇所に値を挿入する際に利用できます。