Interface: ProcedureBuilder<TParams>
Type parameters
Parameter |
---|
TParams extends AnyProcedureBuilderParams |
Methods
input()
input<
$Parser
>(schema
):ProcedureBuilder
< {_config
:TParams
["_config"
];_ctx_out
:TParams
["_ctx_out"
];_input_in
:OverwriteIfDefined
<TParams
["_input_in"
],inferParser
<$Parser
>["in"
] >;_input_out
:OverwriteIfDefined
<TParams
["_input_out"
],inferParser
<$Parser
>["out"
] >;_meta
:TParams
["_meta"
];_output_in
:TParams
["_output_in"
];_output_out
:TParams
["_output_out"
];} >
Add an input parser to the procedure.
Type parameters
Parameter |
---|
$Parser extends Parser |
Parameters
Parameter | Type |
---|---|
schema | TParams ["_input_out" ] extends typeof unsetMarker ? $Parser : inferParser < $Parser >["out" ] extends undefined | Record < string , unknown > ? TParams ["_input_out" ] extends undefined | Record < string , unknown > ? undefined extends any [any ] ? undefined extends any [any ] ? $Parser : "Cannot chain an optional parser to a required parser" : $Parser : "All input parsers did not resolve to an object" : "All input parsers did not resolve to an object" |
Returns
ProcedureBuilder
< {_config
: TParams
["_config"
]; _ctx_out
: TParams
["_ctx_out"
]; _input_in
: OverwriteIfDefined
< TParams
["_input_in"
], inferParser
< $Parser
>["in"
] >; _input_out
: OverwriteIfDefined
< TParams
["_input_out"
], inferParser
< $Parser
>["out"
] >; _meta
: TParams
["_meta"
]; _output_in
: TParams
["_output_in"
]; _output_out
: TParams
["_output_out"
];} >
Source
packages/server/src/core/internals/procedureBuilder.ts:73
meta()
meta(
meta
):ProcedureBuilder
<TParams
>
Add a meta data to the procedure.
Parameters
Parameter | Type |
---|---|
meta | TParams ["_meta" ] |
Returns
ProcedureBuilder
< TParams
>
Source
packages/server/src/core/internals/procedureBuilder.ts:118
mutation()
mutation<
$Output
>(resolver
):MutationProcedure
< {input
:DefaultValue
<TParams
["_input_in"
],void
>;output
:DefaultValue
<TParams
["_output_out"
],$Output
>;} >
Mutation procedure
Type parameters
Parameter |
---|
$Output |
Parameters
Parameter | Type |
---|---|
resolver | (opts ) => MaybePromise < DefaultValue < TParams ["_output_in" ], $Output > > |
Returns
MutationProcedure
< {input
: DefaultValue
< TParams
["_input_in"
], void
>; output
: DefaultValue
< TParams
["_output_out"
], $Output
>;} >
Source
packages/server/src/core/internals/procedureBuilder.ts:142
output()
output<
$Parser
>(schema
):ProcedureBuilder
< {_config
:TParams
["_config"
];_ctx_out
:TParams
["_ctx_out"
];_input_in
:TParams
["_input_in"
];_input_out
:TParams
["_input_out"
];_meta
:TParams
["_meta"
];_output_in
:inferParser
<$Parser
>["in"
];_output_out
:inferParser
<$Parser
>["out"
];} >
Add an output parser to the procedure.
Type parameters
Parameter |
---|
$Parser extends Parser |
Parameters
Parameter | Type |
---|---|
schema | $Parser |
Returns
ProcedureBuilder
< {_config
: TParams
["_config"
]; _ctx_out
: TParams
["_ctx_out"
]; _input_in
: TParams
["_input_in"
]; _input_out
: TParams
["_input_out"
]; _meta
: TParams
["_meta"
]; _output_in
: inferParser
< $Parser
>["in"
]; _output_out
: inferParser
< $Parser
>["out"
];} >
Source
packages/server/src/core/internals/procedureBuilder.ts:104
query()
query<
$Output
>(resolver
):QueryProcedure
< {input
:DefaultValue
<TParams
["_input_in"
],void
>;output
:DefaultValue
<TParams
["_output_out"
],$Output
>;} >
Query procedure
Type parameters
Parameter |
---|
$Output |
Parameters
Parameter | Type |
---|---|
resolver | (opts ) => MaybePromise < DefaultValue < TParams ["_output_in" ], $Output > > |
Returns
QueryProcedure
< {input
: DefaultValue
< TParams
["_input_in"
], void
>; output
: DefaultValue
< TParams
["_output_out"
], $Output
>;} >
Source
packages/server/src/core/internals/procedureBuilder.ts:130
subscription()
subscription<
$Output
>(resolver
):SubscriptionProcedure
< {input
:DefaultValue
<TParams
["_input_in"
],void
>;output
:DefaultValue
<TParams
["_output_out"
],$Output
>;} >
Mutation procedure
Type parameters
Parameter |
---|
$Output |
Parameters
Parameter | Type |
---|---|
resolver | (opts ) => MaybePromise < DefaultValue < TParams ["_output_in" ], $Output > > |
Returns
SubscriptionProcedure
< {input
: DefaultValue
< TParams
["_input_in"
], void
>; output
: DefaultValue
< TParams
["_output_out"
], $Output
>;} >
Source
packages/server/src/core/internals/procedureBuilder.ts:154
use()
use<
$Params
>(fn
):CreateProcedureReturnInput
<TParams
,$Params
>
Add a middleware to the procedure.
Type parameters
Parameter |
---|
$Params extends AnyProcedureParams |
Parameters
Parameter | Type |
---|---|
fn | MiddlewareBuilder < TParams , $Params > | MiddlewareFunction < TParams , $Params > |
Returns
CreateProcedureReturnInput
< TParams
, $Params
>
Source
packages/server/src/core/internals/procedureBuilder.ts:122
Generated using TypeDoc and typedoc-plugin-markdown