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.

Sign up for GitHub

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 missing methods and parameters to documentation #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add missing methods and parameters to documentation #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,17 @@ This requires you to send a unique identifier for each message from the socket.i

## Methods

### .emit(name, message)
### .bind(object, options)

Broadcasts a message to all open windows (including the current window).
Adds new binding.

### .emit(name, message, [id])

Broadcasts a message to all open windows (including the current window), with optional identifier.

### .off(name, fn)

Removes `fn` listener for messages with the given name.

### .on(name, fn)

Expand All @@ -94,6 +102,10 @@ Sets up a listener to be invoked when a message with the given name is received.

Given a unique unique key to represent the function, `fn` will be invoked in only one window. The `ttl` argument represents the number of seconds before the function can be called again.

### .trigger(name)

Manually triggers callbacks for `name`, passing additional parameters as callback arguments.

### Intercom.destroy()

Removes all data associated with intercom from `localStorage`.
Expand Down