Skip to content
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.

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

Update Stream interfaces diagrams #19

Open
blake-regalia opened this issue Jul 10, 2021 · 1 comment
Open

Update Stream interfaces diagrams #19

blake-regalia opened this issue Jul 10, 2021 · 1 comment
Assignees

Comments

@blake-regalia
Copy link

Currently these diagrams show | RegExp for some of the arguments which is from an older version.

@elf-pavlik
Copy link
Member

elf-pavlik commented Jul 12, 2021

We could use Mermaid: Class Diagram to have easily editable source

classDiagram
  class EventEmitter
  class Stream {
    +read() Quad
  }
  EventEmitter <|-- Stream : Extends
  class Source {
    +match(subject: Term, predicate: Term, object: Term, graph: Term) Stream
  }
  class Sink {
    +import(stream: Stream) EventEmitter
  }
  class Store {
    +remove(stream: Stream) EventEmitter
    +removeMatches(subject: Term, predicate: Term, object: Term, graph: Term) EventEmitter
    +deleteGraph(graph: Term) EventEmitter
  }
  Source <|-- Store: Extends
  Sink <|-- Store : Extends
Loading

image

Preview above in live editor

In another repo I have setup to auto render image using github action.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants