Microsoft/TypeScript

Infer array as tuple when used as rest argument in a complex expression

Open

#56.765 aperta il 13 dic 2023

Vedi su GitHub
 (3 commenti) (1 reazione) (0 assegnatari)TypeScript (6726 fork)batch import
Domain: check: Type InferenceHelp WantedPossible Improvement

Metriche repository

Star
 (48.455 star)
Metriche merge PR
 (Merge medio 6g 17h) (9 PR mergiate in 30 g)

Descrizione

🔍 Search Terms

"infer rest array type" "infer rest array args" "infer rest array tuple" "spread argument array expression "

✅ Viability Checklist

⭐ Suggestion

Given the following function

function foo (a: number, b: string, c: boolean) {}

TypeScript already supports inferring that an array used as rest argument should be considered as a tuple:

foo (1, ...(["a", true])) // Works

But if you add some condition to the mix, type inference breaks:

const someCondition = true

foo (1, ...(someCondition ? ["a", true] : ['b', false])) // A spread argument must either have a tuple type or be passed to a rest parameter.(2556)

My suggestion it to add support for inlined array inside complex expression to be used as spread args.

Playground link

📃 Motivating Example

I came accros this issue while designing a database agnostic module based on kysely.

I used to write stuff like so:


const myTableWithId =
  dialect === 'pg'
    ? db.schema
        .createTable('my_table')
        .addColumn('id', 'bigserial', (col) => col.primaryKey())
    : db.schema
        .createTable('my_table')
        .addColumn('id', 'bigint', (col) => col.autoIncrement().primaryKey())

await myTableWithId
  .addColumn('my_col', 'varchar', (col) => col.notNullable())
  .execute()

But this breaks the linear style of the definition. The following notation is more natural:

await db.schema
  .createTable('oauth_device')
  .addColumn(
    'id',
    ...(dialect === 'pg'
      ? ['bigserial', (col) => col.primaryKey()]
      : ['bigint', (col) => col.autoIncrement().primaryKey()])
  )
  .addColumn('my_col', 'varchar', (col) => col.notNullable())
  .execute()

It currently work but requires additional typecasting (see playground link before)

💻 Use Cases

  1. What do you want to use this for? Be able to write more readable code
  2. What shortcomings exist with current approaches? Unnecessarily more verbose
  3. What workarounds are you using in the meantime? Declare the type of the spread tuple and cast every value to that type

Guida contributor