donmccurdy / donmccurdy/property-graph

Return an iterator from listRefs(), listRefMapKeys(), listRefMapValues(), ...

Open
#43 3 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
26
Forks
3
PR merge metrics
No merged PRs in 30d

Description

List methods should return an iterator, rather than allocating an array on each invocation. This should probably be considered a breaking change.

GraphNode:

- [ ] listRefs
- [ ] listRefMapKeys
- [ ] listRefMapValues

Graph:

- [ ] listEdges
- [ ] listParentEdges
- [ ] listChildEdges
- [ ] listParents
- [ ] listChildren

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the listed methods on GraphNode and Graph, then inspect how they currently allocate arrays and how callers consume their results. Check any available tests or usage sites before changing the API; done means all listed methods consistently return iterators and the breaking-change impact is accounted for.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
data
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.