Merge pull request #834 from codingwithmanny/docs/fix-validateOpenRPC…

…Document-example Docs/fix validate open rpc document example
open-rpc · May 7, 2024 · cbd7295 · cbd7295
2 parents 32a98ff + fbe412d
commit cbd7295
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/src/validate-open-rpc-document.ts b/src/validate-open-rpc-document.ts
@@ -35,12 +35,12 @@ 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;
+ * 
+ * const result = validateOpenRPCDocument(badOpenRPCDocument);
+ * if (result !== true) {
+ *   console.error(result);
  * }
  * ```
  *