@hyperjump/json-schema 0.22.0 → 0.23.2

package/README.md

@@ -101,10 +101,14 @@ MediaTypePlugin to support that.
     way JSON is supported.
 * **MediaTypePlugin**: object
 
-    * parse: (response: Response) => string -- Given a fetch Response object,
-      parse the body of the request
-    * matcher: (path) => boolean -- Given a filesystem path, return whether or
-      not the file should be considered a member of this media type
+    * parse: (response: Response, mediaTypeParameters: object) => [SchemaObject, string]
+
+      Given a fetch Response object, parse the body of the request. Return the
+      parsed schema and an optional default dialectId.
+    * matcher: (path) => boolean
+
+      Given a filesystem path, return whether or not the file should be
+      considered a member of this media type.
 
 ```javascript
 const JsonSchema = require("@hyperjump/json-schema");
@@ -113,7 +117,7 @@ const YAML = require("yaml");
 
 // Add support for JSON Schemas written in YAML
 JsonSchema.addMediaTypePlugin("application/schema+yaml", {
-  parse: async (response) => YAML.parse(await response.text()),
+  parse: async (response) => [YAML.parse(await response.text()), undefined],
   matcher: (path) => path.endsWith(".schema.yaml")
 });