Skip to content

Add Symbol.iterator and TS types #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Symbol.iterator and TS types #50

wants to merge 1 commit into from

Conversation

lionel-rowe
Copy link

@lionel-rowe lionel-rowe commented Sep 15, 2025 •
edited
Loading

Closes #52
Closes #51

Usage with iterable protocol (see also updated readme):

console.log([...new LineBreaker('...')]) // [{ position: 3, required: false, substring: '...' }]

for (const bk of new LineBreaker('...')) {
  console.log(bk); // { position: 3, required: false, substring: '...' }
}

Exposed types — I've omitted the low-level methods like getSimpleBreak even though they're technically public:

interface Break {
  position: number;
  required: boolean;
}
interface BreakInfo extends Break {
  substring: string;
}
interface LineBreaker {
  new(input: string): LineBreaker;
  nextBreak(): Break | null;
  [Symbol.iterator](): Generator<BreakInfo, undefined, undefined>;
}

Let me know if this would be preferable as two separate PRs, one for types and the other for Symbol.iterator.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Iteration with [...new LineBreaker('...')] etc TS types
1 participant
@lionel-rowe