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

Add essential documentation #27

Open
ksvan opened this issue Nov 17, 2018 · 3 comments
Open

Add essential documentation #27

ksvan opened this issue Nov 17, 2018 · 3 comments

Comments

@ksvan
Copy link

ksvan commented Nov 17, 2018

Essential documentation for people to really use this

  • How Receieve function works
  • How Emit function works
  • How to provide credentials for config nodes using load()
@knolleary
Copy link
Member

Can you clarify what you mean by emit? Nodes should use node.send to send messages. They shouldn't use the internal event emitter of the node for sending messages. Or do you have something else in mind?

@ksvan
Copy link
Author

ksvan commented Nov 22, 2018

That’s actually a good answer on emit itself and what to use for what purpose:) I just saw it in some samples “out there” when trying to learn this. And i’m thinking only in the context of test-helper usage here btw.

@jensrossbach
Copy link

@knolleary I would also like to know how the credentials that can be passed as third argument to the load function must look like (i.e., what is the expected structure of the object to provide).

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