Skip to content

Interface: GithubCreateOrUpdatePrBuilder<TIn, TOut, THandle> ​

Defined in: github/src/builders/github-create-or-update-pr-builder.ts:13

Fluent builder for a GithubCreateOrUpdatePrNode domain step (github.createOrUpdatePr).

Supports narrowing the step's input and output Zod validation schemas before compiling into a deeply frozen passive GithubCreateOrUpdatePrNode via .toAST().

Extends ​

Type Parameters ​

Type ParameterDefault typeDescription
TInunknownValidated step input payload type.
TOutunknownValidated step output payload type.
THandleunknownRuntime handle type of the enclosing isolation scope.

Methods ​

input() ​

ts
input<TNextIn>(schema): GithubCreateOrUpdatePrBuilder<TNextIn, TOut, THandle>;

Defined in: github/src/builders/github-create-or-update-pr-builder.ts:32

Binds a new Zod input schema for the pull-request creation step.

Returns a new immutable builder instance typed for TNextIn.

Type Parameters ​

Type ParameterDescription
TNextInNew validated step input payload type.

Parameters ​

ParameterTypeDescription
schemaZodType<TNextIn>Zod schema validating step input.

Returns ​

GithubCreateOrUpdatePrBuilder<TNextIn, TOut, THandle>

Updated immutable builder instance.


output() ​

ts
output<TNextOut>(schema): GithubCreateOrUpdatePrBuilder<TIn, TNextOut, THandle>;

Defined in: github/src/builders/github-create-or-update-pr-builder.ts:47

Binds a new Zod output schema for the pull-request creation step.

Returns a new immutable builder instance typed for TNextOut.

Type Parameters ​

Type ParameterDescription
TNextOutNew validated step output payload type.

Parameters ​

ParameterTypeDescription
schemaZodType<TNextOut>Zod schema validating step output.

Returns ​

GithubCreateOrUpdatePrBuilder<TIn, TNextOut, THandle>

Updated immutable builder instance.


toAST() ​

ts
toAST(): GithubCreateOrUpdatePrNode<TIn, TOut, THandle>;

Defined in: github/src/builders/github-create-or-update-pr-builder.ts:58

Compiles the builder configuration into a passive, frozen GithubCreateOrUpdatePrNode.

Preserves all configured projections and boundary schemas on the resulting AST node.

Returns ​

GithubCreateOrUpdatePrNode<TIn, TOut, THandle>

Compiled passive AST node.

Overrides ​

AstBuilder.toAST

Properties ​

PropertyModifierTypeDescriptionDefined in
idreadonlystringUnique step node identifier.github/src/builders/github-create-or-update-pr-builder.ts:19

Released under the MIT License.