Parameter.ts

Parameter.ts overview

Typed SQL Server stored procedure parameter metadata.

This module builds Parameter values that pair a stored procedure parameter name with a Tedious DataType, Tedious ParameterOptions, and a phantom TypeScript value type. Procedure.param and Procedure.outputParam use this metadata, and MssqlClient.call forwards it to Tedious when registering input and output parameters.

See

• make for constructing parameter metadata directly.

Since v4.0.0

---

Exports Grouped by Category

• constructors
  • make
• models
  • Parameter (interface)
• type IDs
  • TypeId
  • TypeId (type alias)

---

constructors

make

Creates typed metadata for a SQL Server stored procedure parameter.

Signature

declare const make: <A>(name: string, type: DataType, options?: ParameterOptions) => Parameter<A>

Source

Since v4.0.0

models

Parameter (interface)

Metadata for a SQL Server stored procedure parameter, including its name, Tedious data type, options, and phantom value type.

Signature

export interface Parameter<out A> {
  readonly [TypeId]: (_: never) => A
  readonly _tag: "Parameter"
  readonly name: string
  readonly type: DataType
  readonly options: ParameterOptions
}

Source

Since v4.0.0

type IDs

TypeId

Runtime type identifier used to mark SQL Server stored procedure parameter metadata.

Signature

declare const TypeId: "~@effect/sql-mssql/Parameter"

Source

Since v4.0.0

TypeId (type alias)

Type-level identifier used to mark SQL Server stored procedure parameter metadata.

Signature

type TypeId = "~@effect/sql-mssql/Parameter"

Source

Since v4.0.0