rdfjs / stream-spec

RDF/JS: Stream interfaces – A specification of a low level interface definition representing RDF data independent of a serialized format in a JavaScript environment.
https://rdf.js.org/stream-spec/
5 stars 2 forks source link

Update Stream interfaces diagrams #19

Open blake-regalia opened 3 years ago

blake-regalia commented 3 years ago

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

elf-pavlik commented 3 years ago

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

image

Preview above in live editor

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