Home Reference Source Test 
import PostBoard from 'seed-engine/src/internal/PostBoard.js'
public class | source

PostBoard

Experemental! Still looking at other ways to implement this that would be more useful for the engine, and lower lookup, post, and watch runtimes.

A "PostBoard" is a messaging system that anyone who has reference to may "post" updates to. Posts are any type of data, assigned by key. Other objects may look at "posts", and continuously watch a "post".

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

posts: {}

public
public

watchers: {}

Method Summary

Public Methods
public

close(key: *, id: *)

public

closeAll(id: *)

public

look(key: *): *

public

post(key: *, message: *)

public

watch(key: *, callback: *, id: undefined): *

Public Constructors

public constructor() source

Public Members

public posts: {} source

public watcherID: number source

public watchers: {} source

Public Methods

public close(key: *, id: *) source

Params:

NameTypeAttributeDescription
key *
id *

public closeAll(id: *) source

Params:

NameTypeAttributeDescription
id *

public look(key: *): * source

Params:

NameTypeAttributeDescription
key *

Return:

*

public post(key: *, message: *) source

Params:

NameTypeAttributeDescription
key *
message *

public watch(key: *, callback: *, id: undefined): * source

Params:

NameTypeAttributeDescription
key *
callback *
id undefined
  • optional
  • default: undefined

Return:

*