Class AlterTypeBuilder<N>

This builder can be used to create alter type queries.

Type Parameters

const N extends string

Index

Constructors

Methods

addValue renameTo renameValue setSchema

Constructors

constructor

new AlterTypeBuilder<const N extends string>(
props: AlterTypeBuilderProps,
): AlterTypeBuilder<N>
Type Parameters
- const N extends string
Parameters
- props: AlterTypeBuilderProps
Returns AlterTypeBuilder<N>
- Defined in schema/alter-type-builder.ts:18

Methods

addValue

addValue<const V extends string>(value: V): AlterTypeAddValueBuilder<V>
Adds a new value to an enum type.
Type Parameters
- const V extends string
Parameters
- value: V
Returns AlterTypeAddValueBuilder<V>
- Defined in schema/alter-type-builder.ts:25

renameTo

renameTo<NN extends string>(
newName: NN extends N ? never : NN,
): QueryFinalizer<AlterTypeNode>
Rename the type.
Type Parameters
- NN extends string
Parameters
- newName: NN extends N ? never : NN
Returns QueryFinalizer<AlterTypeNode>
- Defined in schema/alter-type-builder.ts:37

renameValue

renameValue<const OV extends string, const NV extends string>(
oldValue: OV,
newValue: NV extends OV ? never : NV,
): QueryFinalizer<AlterTypeNode>
Renames a value of an enum type.
Type Parameters
- const OV extends string
- const NV extends string
Parameters
- oldValue: OV
- newValue: NV extends OV ? never : NV
Returns QueryFinalizer<AlterTypeNode>
- Defined in schema/alter-type-builder.ts:51

setSchema

setSchema<const NS extends string>(
schema: NS extends (N extends `${S}.${string}` ? S : never) ? never : NS,
): QueryFinalizer<AlterTypeNode>
Changes the type's schema.
Type Parameters
- const NS extends string
Parameters
- schema: NS extends (N extends `${S}.${string}` ? S : never) ? never : NS
Returns QueryFinalizer<AlterTypeNode>
- Defined in schema/alter-type-builder.ts:69