Skip to content

fix(forms): work around TypeScript 5.7 issue #58731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
crisbeto wants to merge 1 commit into from
Closed

fix(forms): work around TypeScript 5.7 issue #58731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
fix(forms): work around TypeScript 5.7 issue 
Adjusts the return type of `FormBuilder.group` to work around microsoft/TypeScript#60506.
  • Loading branch information
@crisbeto
crisbeto committed Nov 19, 2024
commit 42d74786412bf29400df8084673beaefb5e75527
8 changes: 2 additions & 6 deletions goldens/public-api/forms/index.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,9 +308,7 @@ export class FormBuilder {
control<T>(formState: T | FormControlState<T>, opts: FormControlOptions, asyncValidator: AsyncValidatorFn | AsyncValidatorFn[]): FormControl<T | null>;
// (undocumented)
control<T>(formState: T | FormControlState<T>, validatorOrOpts?: ValidatorFn | ValidatorFn[] | FormControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null): FormControl<T | null>;
group<T extends {}>(controls: T, options?: AbstractControlOptions | null): FormGroup<{
[K in keyof T]: ɵElement<T[K], null>;
}>;
group<T extends {}>(controls: T, options?: AbstractControlOptions | null): ɵNullableFormGroup<T>;
// @deprecated
group(controls: {
[key: string]: any;
Expand Down Expand Up @@ -768,9 +766,7 @@ export class NgSelectOption implements OnDestroy {
export abstract class NonNullableFormBuilder {
abstract array<T>(controls: Array<T>, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null): FormArray<ɵElement<T, never>>;
abstract control<T>(formState: T | FormControlState<T>, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null): FormControl<T>;
abstract group<T extends {}>(controls: T, options?: AbstractControlOptions | null): FormGroup<{
[K in keyof T]: ɵElement<T[K], never>;
}>;
abstract group<T extends {}>(controls: T, options?: AbstractControlOptions | null): ɵNonNullableFormGroup<T>;
abstract record<T>(controls: {
[key: string]: T;
}, options?: AbstractControlOptions | null): FormRecord<ɵElement<T, never>>;
Expand Down
16 changes: 11 additions & 5 deletions packages/forms/src/form_builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ interface PermissiveAbstractControlOptions extends Omit<AbstractControlOptions,
updateOn?: string;
}

// Note: these two types have been extracted into type aliases to work around a .d.ts generation
// issue in TypeScript 5.7. See: https://github.com/Microsoft/TypeScript/issues/60506. The types
// have to be exported for the workaround to work.
/** Group of nullable form controls. */
export type ɵNullableFormGroup<T> = FormGroup<{[K in keyof T]: ɵElement<T[K], null>}>;

/** Group of non-nullable form controls. */
export type ɵNonNullableFormGroup<T> = FormGroup<{[K in keyof T]: ɵElement<T[K], never>}>;

/**
* ControlConfig<T> is a tuple containing a value of type T, plus optional validators and async
* validators.
Expand Down Expand Up @@ -194,10 +203,7 @@ export class FormBuilder {
* * `updateOn`: The event upon which the control should be updated (options: 'change' | 'blur'
* | submit').
*/
group<T extends {}>(
controls: T,
options?: AbstractControlOptions | null,
): FormGroup<{[K in keyof T]: ɵElement<T[K], null>}>;
group<T extends {}>(controls: T, options?: AbstractControlOptions | null): ɵNullableFormGroup<T>;

/**
* @description
Expand Down Expand Up @@ -418,7 +424,7 @@ export abstract class NonNullableFormBuilder {
abstract group<T extends {}>(
controls: T,
options?: AbstractControlOptions | null,
): FormGroup<{[K in keyof T]: ɵElement<T[K], never>}>;
): ɵNonNullableFormGroup<T>;

/**
* Similar to `FormBuilder#record`, except any implicitly constructed `FormControl`
Expand Down