JSPM

Assertion Library for Browsers and NodeJS

Based on NodeJS Assert module.

API

NodeJS API

• Assert Documentation

Additional API

• has / hasNot Subset matching

  // Substring search
  assert.has(String, String | RegExp, ?message);
  
  // Simple property existance check
  assert.has(Object, String);
  
  // Sub-object match
  assert.has(Object, Object);
  
  // Check if item exists in set
  assert.has(Array, Primitive);
  
  // Subset match
  assert.has(Array, Array);

  When checking arrays or objects deep matching is performed. See tests

  assert.has({
      foo: 'foo',
      bar: {
          qux: {
              qux: 'qux'
              quux: 'quux'
          },
          baz: [1, 2, 3]
      }
  }, {
      foo: null,
      bar: {
          baz: [1],
          qux: {
              qux: 'qux'
          }
      }
  });
  

• is/isNot Type check

      // Check by Typename
      assert.is(Any, String, ?message)
      
      // Check by Contructor (instanceof)
      assert.is(Any, Function);

  Typename are extracted from Object.prototype.toString.call, so these are:

      'String'
      'Number'
      'Null'
      'Undefined'
      'Function'
      'RegExp'
      'Date'
      'Object' // any `object` will pass here
      'HTML**' // DOM Node, e.g. HTMLBodyElement
      'CustomEvent'
      ...
      all other buit-in types

• await Wait for a callback

  Create a wrapper function to ensure that the function is called.

      // ! Arguments order does not matter
      var fn = assert.await(
          String /*optional - name of this wrapper
          Function/*optional - wrap the function */,
          Object/*optional - use binded context */,
          Number/*optional - expectation count, default is `1`*/
      );
      
      // creates item in assert.callbacks
      [
          {
              name: String,
              error: Error, // to receive the stack trace
              count: Number
          }
      ];
      
      // after the `fn` function is called `count` times, then the object is removed
      // from the callbacks set
      
      
      // Example
      var fn = assert.await();
      assert.callbacks.length === 1;
      try {
          throw new Error()
      } catch {
          fn();
      }
      
      assert.callbacks.length === 0;