Change handleEvent option to eventHandler.

Author: davidlehn

CHANGELOG.md

@@ -5,7 +5,7 @@
 - Support test environment in EARL output.
 - Support benchmark output in EARL output.
 - Benchmark comparison tool.
-- Event handler option "`handleEvent`" to allow custom handling of warnings and
+- Event handler option `"eventHandler"` to allow custom handling of warnings and
   potentially other events in the future. Handles event replay for cached
   contexts.
 

lib/context.js

@@ -67,20 +67,20 @@ api.process = async ({
 
   // event handler for capturing events to replay when using a cached context
   const events = [];
-  const handleEvent = [
+  const eventHandler = [
     ({event, next}) => {
       events.push(event);
       next();
     }
   ];
   // chain to original handler
-  if(options.handleEvent) {
-    handleEvent.push(options.handleEvent);
+  if(options.eventHandler) {
+    eventHandler.push(options.eventHandler);
   }
   // store original options to use when replaying events
   const originalOptions = options;
   // shallow clone options with custom event handler
-  options = Object.assign({}, options, {handleEvent});
+  options = Object.assign({}, options, {eventHandler});
 
   // resolve contexts
   const resolved = await options.contextResolver.resolve({

lib/events.js

@@ -19,7 +19,7 @@ module.exports = api;
 /**
  * Handle an event.
  *
- * Top level APIs have a common 'handleEvent' option. This option can be a
+ * Top level APIs have a common 'eventHandler' option. This option can be a
  * function, array of functions, object mapping event.code to functions (with a
  * default to call next()), or any combination of such handlers. Handlers will
  * be called with an object with an 'event' entry and a 'next' function. Custom
@@ -34,14 +34,14 @@ module.exports = api;
  *   {string} level - severity level, one of: ['warning']
  *   {string} message - human readable message
  *   {object} details - event specific details
- * @param {object} options - original API options
+ * @param {object} options - processing options
  */
 api.handleEvent = ({
   event,
   options
 }) => {
   const handlers = [].concat(
-    options.handleEvent ? _asArray(options.handleEvent) : [],
+    options.eventHandler ? _asArray(options.eventHandler) : [],
     _defaultHandler
   );
   _handle({event, handlers});

lib/jsonld.js

@@ -119,7 +119,7 @@ const _resolvedContextCache = new LRU({max: RESOLVED_CONTEXT_CACHE_MAX_SIZE});
  *            unmappable values (or to throw an error when they are detected);
  *            if this function returns `undefined` then the default behavior
  *            will be used.
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the compacted output.
@@ -258,7 +258,7 @@ jsonld.compact = async function(input, ctx, options) {
  *            unmappable values (or to throw an error when they are detected);
  *            if this function returns `undefined` then the default behavior
  *            will be used.
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the expanded output.
@@ -356,7 +356,7 @@ jsonld.expand = async function(input, options) {
  *          [base] the base IRI to use.
  *          [expandContext] a context to expand with.
  *          [documentLoader(url, options)] the document loader.
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the flattened output.
@@ -412,7 +412,7 @@ jsonld.flatten = async function(input, ctx, options) {
  *          [requireAll] default @requireAll flag (default: true).
  *          [omitDefault] default @omitDefault flag (default: false).
  *          [documentLoader(url, options)] the document loader.
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the framed output.
@@ -511,7 +511,7 @@ jsonld.frame = async function(input, frame, options) {
  *          [base] the base IRI to use.
  *          [expandContext] a context to expand with.
  *          [documentLoader(url, options)] the document loader.
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the linked output.
@@ -547,7 +547,7 @@ jsonld.link = async function(input, ctx, options) {
  *            'application/n-quads' for N-Quads.
  *          [documentLoader(url, options)] the document loader.
  *          [useNative] true to use a native canonize algorithm
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the normalized output.
@@ -604,7 +604,7 @@ jsonld.normalize = jsonld.canonize = async function(input, options) {
  *            (boolean, integer, double), false not to (default: false).
  *          [rdfDirection] 'i18n-datatype' to support RDF transformation of
  *             @direction (default: null).
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *
  * @return a Promise that resolves to the JSON-LD document.
  */
@@ -654,7 +654,7 @@ jsonld.fromRDF = async function(dataset, options) {
  *          [produceGeneralizedRdf] true to output generalized RDF, false
  *            to produce only standard RDF (default: false).
  *          [documentLoader(url, options)] the document loader.
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the RDF dataset.
@@ -708,7 +708,7 @@ jsonld.toRDF = async function(input, options) {
  *          [expandContext] a context to expand with.
  *          [issuer] a jsonld.IdentifierIssuer to use to label blank nodes.
  *          [documentLoader(url, options)] the document loader.
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the merged node map.
@@ -748,7 +748,7 @@ jsonld.createNodeMap = async function(input, options) {
  *            new properties where a node is in the `object` position
  *            (default: true).
  *          [documentLoader(url, options)] the document loader.
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the merged output.
@@ -911,7 +911,7 @@ jsonld.get = async function(url, options) {
  * @param localCtx the local context to process.
  * @param [options] the options to use:
  *          [documentLoader(url, options)] the document loader.
- *          [handleEvent] handler for events such as warnings.
+ *          [eventHandler] handler for events.
  *          [contextResolver] internal use only.
  *
  * @return a Promise that resolves to the new active context.

tests/misc.js

@@ -1021,7 +1021,7 @@ describe('events', () => {
 
     let handled = false;
     const e = await jsonld.expand(d, {
-      handleEvent: ({event, next}) => {
+      eventHandler: ({event, next}) => {
         if(event.code === 'invalid reserved term') {
           handled = true;
         } else {
@@ -1046,15 +1046,15 @@ describe('events', () => {
     let handled0 = false;
     let handled1 = false;
     const e0 = await jsonld.expand(d, {
-      handleEvent: {
+      eventHandler: {
         'invalid reserved term': () => {
           handled0 = true;
         }
       }
     });
     // FIXME: ensure cache is being used
     const e1 = await jsonld.expand(d, {
-      handleEvent: {
+      eventHandler: {
         'invalid reserved term': () => {
           handled1 = true;
         }
@@ -1080,7 +1080,7 @@ describe('events', () => {
     let ranHandler1 = false;
     let handled = false;
     const e = await jsonld.expand(d, {
-      handleEvent: [
+      eventHandler: [
         ({next}) => {
           ranHandler0 = true;
           // skip to next handler
@@ -1114,7 +1114,7 @@ describe('events', () => {
 
     let handled = false;
     const e = await jsonld.expand(d, {
-      handleEvent: {
+      eventHandler: {
         'invalid reserved term': ({event}) => {
           assert.equal(event.details.term, '@RESERVED');
           handled = true;
@@ -1141,7 +1141,7 @@ describe('events', () => {
     let ranHandler3 = false;
     let handled = false;
     const e = await jsonld.expand(d, {
-      handleEvent: [
+      eventHandler: [
         ({next}) => {
           ranHandler0 = true;
           next();
@@ -1205,7 +1205,7 @@ describe('events', () => {
     let handledReservedValue = false;
     let handledLanguage = false;
     const e = await jsonld.expand(d, {
-      handleEvent: {
+      eventHandler: {
         'invalid reserved term': () => {
           handledReservedTerm = true;
         },
@@ -1270,7 +1270,7 @@ describe('events', () => {
     let handledLanguage2 = false;
     const e2 = await jsonld.fromRDF(d2, {
       rdfDirection: 'i18n-datatype',
-      handleEvent: {
+      eventHandler: {
         'invalid @language value': () => {
           handledLanguage2 = true;
         }