match-json

match-json

A JavaScript library to test JSON APIs.

It is built to test REST API endpoints but, of course, you can use it to whatever you want.

Install

npm install match-json

Functionality

Of course, match JSON objects.

You can compare primitives.

// Numbers
match(3.1415, 3.1415) // => true
//Strings
match('Uno Dos Tres', 'Uno Dos Tres') // => true
// Booleans
match(false, false) // => true
// And with undefined and null values
match(undefined, undefined) // => true
match(null, null)  // => true

And structures (objects and arrays).

match({ name: 'Link', color: 'green' }, { name: 'Link', color: 'green' }) // => true
match([ 'deku', 'goron', 'zora' ], [ 'deku', 'goron', 'zora' ]) // => true

But the nice part starts here

You can match using functions

// Yeah, with functions!
match({ name: 'Samus' }, hero => hero.name.length >= 5) // => true

Regular expressions

// Yeah, with RegExp too!
match('Kvothe', /K.ot.*e?/) // => true

Check JSON types using contructor functions

// Yeah, with RegExp too!
match(5, Number) // => true

match('Hola, mundo', String) // => true

match(false, Boolean) // => true

And everything together!

match({
        name: { first: 'Walter', last: 'White' },
        age: 51,
        breakingBad: true
      },
      {
        name: { first: /[\w]*/, last: 'White' },
        age: age => age > 18,
        breakingBad: Boolean
      }); // => true

Bake

Also, you can also predefine an expected pattern.

const nameIsLarge = match.bake({ name: name => name.length > 10  })
nameIsLarge('Tom') // => false
nameIsLarge('Tooooooooom') // => true

Signatures

Match signature

• match( a : T, b : T ) : boolean
• match( a : T, test : RegExp ) : boolean
• match( a : T, test : PredicateFunction ) : boolean
• match( a : T, test : JSONTypeConstructorFunction ) : boolean

Bake signature

• bake( a: T ) : PredicateFunction

( where PredicateFunction = ( w : T ) : boolean ) ( where JSONTypeConstructorFunction = Number, String OR Boolean )

Notes

• Is worth to mention that you only can use JSON-data as the first argument of the function. Not functions or RegExp.
• I made this for test my API endpoints, thats why it only acepts to test JSON data.

Contribution

Feel free to open an issue and/or make a PR if you found a bug or think in a way this lib or even the README can be improved.

License

MIT