powPolicy: add example

2023-04-18 18:30:42 -04:00 · 2023-04-18 18:30:42 -04:00 · 6f77ec418b
commit 6f77ec418b
parent 33ef127ca7
1 changed files with 8 additions and 1 deletions
--- a/src/policies/pow-policy.ts
+++ b/src/policies/pow-policy.ts
@ -8,7 +8,14 @@ interface POW {
  difficulty?: number;
 }

-/** Reject events which don't meet Proof-of-Work ([NIP-13](https://github.com/nostr-protocol/nips/blob/master/13.md)) criteria. */
+/**
+ * Reject events which don't meet Proof-of-Work ([NIP-13](https://github.com/nostr-protocol/nips/blob/master/13.md)) criteria.
+ *
+ * @example
+ * ```ts
+ * powPolicy(msg, { difficulty: 20 });
+ * ```
+ */
 const powPolicy: Policy<POW> = ({ event }, opts = {}) => {
  const { difficulty = 1 } = opts;