docs: validateOpenRPCDocument Example

Adjusted example code with import and try/catch BREAKING CHANGE: N
open-rpc · Jan 2, 2023 · a71ecde · a71ecde
1 parent de615ee
commit a71ecde
Showing 1 changed file with 10 additions and 6 deletions.
diff --git a/src/validate-open-rpc-document.ts b/src/validate-open-rpc-document.ts
@@ -35,13 +35,17 @@ export class OpenRPCDocumentValidationError implements Error {
  * @example
  * ```typescript
  *
- * const { types } from "@open-rpc/meta-schema"
- * const { validateOpenRPCDocument } from "@open-rpc/schema-utils-js";
- * const badOpenRPCDocument = {};
- * const errors = validateOpenRPCDocument({});
- * if (errors) {
- *   // handle errors
+ * 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
  * }
+
  * ```
  *
  */