[rbdr/api-notation.vim] / example-syntax.api

// This is an example of a definition.
Forum.Models.Post
  +glyphs <Array<String>>
  -id <UUID>
  -created_at <Date>
  -parent_id <UUID>
  -text <String>
  -author <Author>
  // Comments are also
  // Allowed in the middle
  ~>textUpdated(text <String>)
  ->authorUpdated(author <Author>)
  <~textWillUpdate(text <String>)
  <-postWillRender(post <Forum.Models.Post>)
  +>authorUpdated(author <Author>)
  <+textWillUpdate(text <String>)
  ::getAll(parent_id <UUID>) => Promise<Array<Forum.Models.Post>> #> NotFoundError,DisplayError
  ::get(id <UUID>) => Promise<Forum.Models.Post>
  #update(text <String>) => Promise<void>
  #transform([transformer] <Function<T>(T) => boolean>)
Commit	Line	Data
c0991136 RBR	1	// This is an example of a definition.
	2	Forum.Models.Post
	3	+glyphs <Array<String>>
	4	-id <UUID>
	5	-created_at <Date>
	6	-parent_id <UUID>
	7	-text <String>
	8	-author <Author>
	9	// Comments are also
	10	// Allowed in the middle
	11	~>textUpdated(text <String>)
	12	->authorUpdated(author <Author>)
	13	<~textWillUpdate(text <String>)
	14	<-postWillRender(post <Forum.Models.Post>)
	15	+>authorUpdated(author <Author>)
	16	<+textWillUpdate(text <String>)
	17	::getAll(parent_id <UUID>) => Promise<Array<Forum.Models.Post>> #> NotFoundError,DisplayError
	18	::get(id <UUID>) => Promise<Forum.Models.Post>
	19	#update(text <String>) => Promise<void>
	20	#transform([transformer] <Function<T>(T) => boolean>)