Typescript function accept a single string or an array of strings

Question

The function below takes 2 arguments, a mandatory tableName and an optional connectionName:

export const clearTable = async (
  tableName: string[],
  connectionName = 'default'
) => {
  try {
    const connection = getConnection(connectionName)
    const promises = tableName.map((table) =>
      connection.query(`DELETE FROM ${table}`)
    )
    await Promise.all(promises)
  } catch (error) {
    throw new Error(
      `Failed to clear table '${tableName}' on database '${connectionName}': ${error}`
    )
  }
}

Calling this function:

clearTable(['table1', 'table2']) // works fine because it receives an array
clearTable('table3') // fails because it's not an array > TypeError: tableName.map is not a function

In one way or another it should be possible to convert a single string to an array of strings to be able to use the same logic with array.map. We've also looked at the REST parameter as suggested here but that seems to be not possible as a rest parameter can be zero or more and we need at least one.

What is the correct way to handle this situation?

But then the map function wont work on tablename like tablename.map(). — DarkLite1
– DarkLite1, Commented Sep 23, 2020 at 7:50
@DarkLite1 Then your function needs to check the typeof tableName before deciding if it should be treated like a string or an array of strings. — Terry
– Terry, Commented Sep 23, 2020 at 7:51
Of course not, so you need to handle that in the runtime logic too. E.g. use [tableName] if it's not already an array. — jonrsharpe
– jonrsharpe, Commented Sep 23, 2020 at 7:51
@jonrsharpe "Of course not" or "How would there be" is not the best expression if you keep in mind that we are at Stackoverflow a place where the questioner does not know everything. Its 100% valid to not have the same knowledge like everybody. Not knowing that typescript is stripped out at runtime can be explained straight without a negative touch. — Jonathan Stellwag
– Jonathan Stellwag, Commented Sep 23, 2020 at 8:03

adiga · Accepted Answer · 2020-09-23 08:04:17Z

3

First modify parameter type from string[] to string[] | string and then in try block, when you assign value to promises, add the type check like so: Array.isArray(tableName).

export const clearTable = async (
  tableName: string[] | string,
  connectionName = 'default'
) => {
  try {
    const connection = getConnection(connectionName)
    const promises = Array.isArray(tableName) ?
      tableName.map((table) => connection.query(`DELETE FROM ${table}`))
      :
      connection.query(`DELETE FROM ${tableName}`))
    await Promise.all(promises)
  } catch (error) {
    throw new Error(
      `Failed to clear table '${tableName}' on database '${connectionName}': ${error}`
    )
  }
}

edited Sep 23, 2020 at 8:04

adiga

35.4k9 gold badges65 silver badges88 bronze badges

answered Sep 23, 2020 at 7:55

Ana Svitlica

4532 silver badges14 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

DarkLite1 Over a year ago

I would rather convert a single string to an array of strings frist. But I'll figure it out. Thanks for the help :)

DarkLite1 Over a year ago

Figured it out if (typeof tableName === 'string') { tableName = [tableName] }. Thanks again for putting me on the right path.

Jonathan Stellwag · Accepted Answer · 2020-09-23 08:17:28Z

3

If you want to break down the string | string[] => string[] problem to one function you can write the following and use it in multiple places:

function convert(param: string | string[]): string[] {
  return typeof param === 'string'
    ? [param]
    : param
}

answered Sep 23, 2020 at 8:17

Jonathan Stellwag

4,3055 gold badges30 silver badges58 bronze badges

1 Comment

DarkLite1 Over a year ago

I like this modular approach, makes it very convenient. Thank you for sharing :)

Mohammadreza Askari · Accepted Answer · 2024-08-15 18:02:40Z

-1

If you want to convert anything to array, try this extension:

declare global {
  interface ArrayConstructor {
    make<T>(v: T | T[]): T[];
  }
}
export function ArrayOf<T = any>(arg: T | T[]): T[] {
  return Array.isArray(arg) ? [...arg as T[]] : [...[arg as T]];
}
Array.make = function <T = any>(arg: T | T[]): T[] {
  return ArrayOf<T>(arg);
}

answered Aug 15, 2024 at 18:02

Mohammadreza Askari

5917 silver badges9 bronze badges

Collectives™ on Stack Overflow

Typescript function accept a single string or an array of strings

3 Answers 3

2 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related