Parameter

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.

4 exports Added in v4.0.0 Source

Constructors

make

Added in v4.0.0 Source

Creates typed metadata for a SQL Server stored procedure parameter.

Signature

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

Models

Parameter interface

Added in v4.0.0 Source

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

Signature

interface Parameter<out A> {
  readonly _tag: "Parameter";
  readonly "~@effect/sql-mssql/Parameter": (_: never) => A;
  readonly name: string;
  readonly options: ParameterOptions;
  readonly type: DataType;
}

Type IDs

TypeId

Added in v4.0.0 Source

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

Signature

declare const TypeId: TypeId

TypeId type

Added in v4.0.0 Source

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

Signature

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