Skip to content

Commit

Permalink
chore(docs): deprecate readQuads
Browse files Browse the repository at this point in the history
  • Loading branch information
jeswr committed Jul 28, 2024
1 parent 0ba9ec2 commit b0bdf1b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -332,9 +332,8 @@ The store provides the following manipulation methods in addition to implementin
### Searching quads or entities
The store provides the following search methods
([documentation](http://rdfjs.github.io/N3.js/docs/N3Store.html)):
- `readQuads` returns a generator of quads matching the given pattern
- `match` returns a stream and stream of quads matching the given pattern
- `getQuads` returns an array of quads matching the given pattern
- `match` returns a stream of quads matching the given pattern
- `countQuads` counts the number of quads matching the given pattern
- `forEach` executes a callback on all matching quads
- `every` returns whether a callback on matching quads always returns true
Expand Down
7 changes: 5 additions & 2 deletions src/N3Store.js
Original file line number Diff line number Diff line change
Expand Up @@ -377,8 +377,11 @@ export default class N3Store {
return [...this.readQuads(subject, predicate, object, graph)];
}

// ### `readQuads` returns an generator of quads matching a pattern.
// Setting any field to `undefined` or `null` indicates a wildcard.
/**
* `readQuads` returns an generator of quads matching a pattern.
* Setting any field to `undefined` or `null` indicates a wildcard.
* @deprecated Use `match` instead.
*/
*readQuads(subject, predicate, object, graph) {
// Convert terms to internal string representation
graph = graph && termToId(graph);
Expand Down

0 comments on commit b0bdf1b

Please sign in to comment.