README.md

class Sql

Documentation Index

import {Sql} from "https://deno.land/x/[email protected]/mod.ts"

This class has

• constructor
• 2 properties: estimatedByteLength, sqlSettings
• 5 methods: concat, append, encode, toString, toSqlBytesWithParamsBackslashAndBuffer
• 2 protected properties: strings, params

🔧 constructor(sqlSettings: SqlSettings, onArrow?: OnArrow, strings?: string[], params?: unknown[])

📄 estimatedByteLength: number

📄 sqlSettings: SqlSettings

⚙ concat(other: Sql): Sql

⚙ append(other: Sql): this

⚙ encode(putParamsTo?: unknown[], mysqlNoBackslashEscapes: boolean=false, useBuffer?: Uint8Array, useBufferFromPos: number=0, defaultParentName?: Uint8Array): Uint8Array

If useBuffer is provided, and it has enough size, will encode to it, and return a useBuffer.subarray(0, N). Else, will return a subarray of a new Uint8Array. If useBufferFromPos is provided, will append to the useBuffer after this position.

⚙ toString(putParamsTo?: unknown[], mysqlNoBackslashEscapes: boolean=false): string

⚙ toSqlBytesWithParamsBackslashAndBuffer(putParamsTo: unknown[] | undefined, mysqlNoBackslashEscapes: boolean, useBuffer: Uint8Array): Uint8Array

📄 protected strings: string[]

📄 protected params: unknown[]