docs: Adjusted try/catch

Removed try catch in favour of result because it doesn't throw an error BREAKING CHANGE: N
open-rpc · Jan 2, 2023 · ff7cf33 · ff7cf33
1 parent a71ecde
commit ff7cf33
Showing 1 changed file with 4 additions and 8 deletions.
diff --git a/src/validate-open-rpc-document.ts b/src/validate-open-rpc-document.ts
@@ -37,15 +37,11 @@ export class OpenRPCDocumentValidationError implements Error {
  *
  * import { validateOpenRPCDocument } from "@open-rpc/schema-utils-js";
  * const badOpenRPCDocument = {} as any;
- * try {
- *   const isValid = validateOpenRPCDocument(badOpenRPCDocument);
- *   if (isValid) {
- *     // handle validity
- *   }
- * } catch (error) {
- *   // handle error
+ * 
+ * const result = validateOpenRPCDocument(badOpenRPCDocument);
+ * if (result !== true) {
+ *   console.error({ error: result })
  * }
-
  * ```
  *
  */