microsoft / microsoft/TypeScript

`String.prototype.split()` with a regex containing a capturing group can return an array of `string | undefined`.

Open
#60,941 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

⚙ Compilation target

any

⚙ Library

esnext, dom

Missing / Incorrect Definition

Using split with a negative lookahead and a capturing group can return undefined. See the attached screenshot. When iterating over the array, we lose type safety and encounter runtime errors.

Image

Sample Code
'a,b,c'.split(/,(?!(a))/) // Types as string[]
Documentation Link

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the String.prototype.split entry point in the esnext and dom library definitions and compare its current return type with the sample 'a,b,c'.split(/,(?!(a))/). Check how capturing groups that do not participate are represented at runtime, then add coverage showing that the resulting array type accounts for undefined.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.