Skip to content

Commit 919e918

Browse files
committed
docs: add validate function to readme
1 parent c36fefa commit 919e918

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,19 @@ class PubsubImplementation extends Pubsub {
6868
}
6969
```
7070

71+
### Validate
72+
73+
Validates the signature of a message.
74+
75+
#### `pubsub.validate(message, callback)`
76+
77+
##### Parameters
78+
79+
| Name | Type | Description |
80+
|------|------|-------------|
81+
| message | `Message` | a pubsub message |
82+
| callback | `function(Error, Boolean)` | calls back with true if the message is valid |
83+
7184
## Implementations using this base protocol
7285

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

0 commit comments

Comments
 (0)