Bad function overloading JS-0388
Anti-pattern
Minor
8 days ago
—
5 months old
These overloads can be combined into one signature taking
UpsertDatabaseString | UpsertFileString196
197interface UpsertSingleKey {
198 (params: UpsertDatabaseString): Promise<SourceStringsModel.String>
199 (params: UpsertFileString): Promise<SourceStringsModel.String>200}
201
202interface UpsertDatabaseString {These overloads can be combined into one signature taking
Array<AddFileStringParams> | Array<AddDatabaseStringParams>178}
179interface AddMultipleKeys {
180 (params: Array<AddFileStringParams>): Promise<Array<ResponseObject<SourceStringsModel.String>>>
181 (params: Array<AddDatabaseStringParams>): Promise<Array<ResponseObject<SourceStringsModel.String>>>182}
183
184interface AddDatabaseStringParams {These overloads can be combined into one signature taking
AddDatabaseStringParams | AddFileStringParams174
175interface AddSingleKey {
176 (params: AddDatabaseStringParams): Promise<SourceStringsModel.String>
177 (params: AddFileStringParams): Promise<SourceStringsModel.String>178}
179interface AddMultipleKeys {
180 (params: Array<AddFileStringParams>): Promise<Array<ResponseObject<SourceStringsModel.String>>>These overloads can be combined into one signature taking
Array<UpdateStringByKey> | Array<UpdateStringById>169}
170interface UpdateMultipleStrings {
171 (updates: Array<UpdateStringByKey>): Promise<Array<ResponseObject<SourceStringsModel.String>>>
172 (updates: Array<UpdateStringById>): Promise<Array<ResponseObject<SourceStringsModel.String>>>173}
174
175interface AddSingleKey {These overloads can be combined into one signature taking
UpdateStringByKey | UpdateStringById165
166interface UpdateSingleString {
167 ({ key, updatedString, isDatabaseString }: UpdateStringByKey): Promise<SourceStringsModel.String>
168 ({ crowdinId, updatedString }: UpdateStringById): Promise<SourceStringsModel.String>169}
170interface UpdateMultipleStrings {
171 (updates: Array<UpdateStringByKey>): Promise<Array<ResponseObject<SourceStringsModel.String>>>
Description
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Bad Practice
function f(x: number): void;
function f(x: string): void;
f(): void;
f(...x: number[]): void;
Recommended
function f(x: number | string): void;
function f(x?: ...number[]): void;