Repository navigation
In AIO docs, indicate thatReactiveFormsModule.withConfig method is deprecated #22640
Description
Example:
export class ReactiveFormsModule {
static withConfig(opts: {
/** @deprecated from v6 */ warnOnNgModelWithFormControl: 'never' | 'once' | 'always'
}): ModuleWithProviders {
return {
ngModule: ReactiveFormsModule,
providers: [{
provide: NG_MODEL_WITH_FORM_CONTROL_WARNING,
useValue: opts.warnOnNgModelWithFormControl
}]
};
}
}
Activity
petebacondarwin commentedon Mar 8, 2018
Can we clarify what should happen if this occurs?
Right now, "literal types" like this are not currently documented in any real sense except by a description on the parameter itself. Moreover, as it stands right now, they are not parsed as "dgeni documents" in themselves so we don't read any jsdoc tags on such a comment. The TypeScript parser is able to read the comment and attach it appropriately in its AST so it would be possible to do something with it.
That being said, I would like to propose that if one wants to mark up literal types like this, then it is an indicator that perhaps it is time to convert the literal type into an interface instead. This can then be fully documented and each of its members can be tagged individually.
petebacondarwin commentedon Mar 8, 2018
@IgorMinar - the last paragraph of my previous comment is perhaps a more general comment about the Angular code base. I think we use too many literal types, especially large ones, which might look neat at the time and work well with intellisense but are a pain to document (as @jbogarthyde has found). My understanding from @alxhub is that too many interfaces are frowned upon as it dilutes the API surface, but I would argue it just moves the API surface complexity elsewhere. From a documentation point of view, we could tag some API elements as "primary" and make them more visually prominent in the docs. Perhaps we could filter out the auxiliary API elements from the main views and only show them if requested?
12 remaining items
[-]API docs should support deprecated properties in object literals[/-][+]Deprecate `ReactiveFormsModule.withConfig` method[/+]jenniferfell commentedon May 10, 2019
Related issue proposing to add properties and methods to the Deprecations summary
deprecations.md: #30098[-]Deprecate `ReactiveFormsModule.withConfig` method[/-][+]In AIO docs, indicate that`ReactiveFormsModule.withConfig` method is deprecated[/+]angular-robot commentedon Jun 4, 2021
Just a heads up that we kicked off a community voting process for your feature request. There are 20 days until the voting process ends.
Find more details about Angular's feature request process in our documentation.
angular-robot commentedon Jun 24, 2021
Thank you for submitting your feature request! Looks like during the polling process it didn't collect a sufficient number of votes to move to the next stage.
We want to keep Angular rich and ergonomic and at the same time be mindful about its scope and learning journey. If you think your request could live outside Angular's scope, we'd encourage you to collaborate with the community on publishing it as an open source package.
You can find more details about the feature request process in our documentation.
mgechev commentedon Mar 21, 2022
Seems like the issue is no longer relevant. Please open a new issue if I'm mistaken.
angular-automatic-lock-bot commentedon Apr 21, 2022
This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.
Read more about our automatic conversation locking policy.
This action has been performed automatically by a bot.