Skip to content

Commit

Permalink
docs: add validate function to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobheun committed Jul 8, 2019
1 parent c36fefa commit 919e918
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,19 @@ class PubsubImplementation extends Pubsub {
}
```

### Validate

Validates the signature of a message.

#### `pubsub.validate(message, callback)`

##### Parameters

| Name | Type | Description |
|------|------|-------------|
| message | `Message` | a pubsub message |
| callback | `function(Error, Boolean)` | calls back with true if the message is valid |

## Implementations using this base protocol

You can use the following implementations as examples for building your own pubsub implementation.
Expand Down

0 comments on commit 919e918

Please sign in to comment.