@tsdrivers/mssql

Appearance

@tsdrivers/mssql / ExecResult

Class: ExecResult ​

Defined in: projects/ts-mssql/core/exec_result.ts:30

Result from exec() — supports OUTPUT parameters and multiple result sets.

Example ​

ts
const result = await cn.exec("sp_MyProc", {
  input: 42,
  output: { value: null, type: "int", output: true },
}, { commandType: "stored_procedure" });

result.rowsAffected;             // number
result.resultSets;               // number (count)
result.getOutput<number>("output"); // OUTPUT param value
result.getResults<T>(0);          // T[] from result set 0
result.getResultFirst<T>(0);      // T | undefined

Properties ​

resultSets ​

readonly resultSets: number

Defined in: projects/ts-mssql/core/exec_result.ts:35

Number of result sets returned.

rowsAffected ​

readonly rowsAffected: number

Defined in: projects/ts-mssql/core/exec_result.ts:32

Number of rows affected by the statement.

Methods ​

getOutput() ​

getOutput<T>(name): T

Defined in: projects/ts-mssql/core/exec_result.ts:53

Get the value of an OUTPUT parameter by name. The @ prefix is optional — getOutput("myParam") and getOutput("@myParam") are equivalent.

Type Parameters ​

T ​

T = unknown

Parameters ​

name ​

string

Returns ​

T

Throws ​

If the named output parameter does not exist.

getResultFirst() ​

getResultFirst<T>(index): T | undefined

Defined in: projects/ts-mssql/core/exec_result.ts:82

Get the first row from the result set at the given index, or undefined.

Type Parameters ​

T ​

T = Record<string, unknown>

Parameters ​

index ​

number

Returns ​

T | undefined

Throws ​

If the index is out of range.

getResults() ​

getResults<T>(index): T[]

Defined in: projects/ts-mssql/core/exec_result.ts:66

Get all rows from the result set at the given index.

Type Parameters ​

T ​

T = Record<string, unknown>

Parameters ​

index ​

number

Returns ​

T[]

Throws ​

If the index is out of range.