wea

weaselpecker

Waterline Simple Mocking Library

Showing:

Popularity

Downloads/wk

78

GitHub Stars

12

Maintenance

Last Commit

6yrs ago

Contributors

3

Package

Dependencies

1

Size (min+gzip)

1.1KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

weaselpecker

Waterline Simple Mocking Library

Installation

npm install weaselpecker --save-dev

Quick Example

var weaselpecker = require('weaselpecker');
// Create a model mock instance
var ModelMock = weaselpecker.mock();
// Set results for find method
ModelMock.setResults('find', [
  [{name: 'pecker'}]
]);

ModelMock.find({})
         .where({})
         .populate('anything')
         .exec(function(err, results){
           console.log(results); // [{name: 'pecker'}]
         });

Documentation

weaselpecker

Default available model methods

['hasJoin', 'join', 'create', 'find', 'findOne', 'update', 'destroy', 'count']

mock([options])

Creates a new instance of a mock model

Options

Array options.extraModelMethods

Array with custom methods to be attached to the mocked model

Example

var Model = weaselpecker.mock({
  extraModelMethods: ['findByID']
});

Model.setResults('findByID',  [fixture1, fixture2] );

Model.findByID({})
.exec(function(err, results){
  //extra logic here
});

setResults(str, arr)

Sets mock results for an specific model method call. Results are returned depending the order defined in the array. If there's only one result left it will always return that as result. If an Error object is listed, it will be passed as an error.

Example

  Model.setResults('find', [new Error('error1'), 'result2']);
  //first call
  Model.find({})
    .exec(function(err, result){
      console.log(err); // error1
      //second call
      Model.find({})
      .exec(function(err, result){
        console.log(result); //result2
        //third call
        Model.find({}, function(err, result){
          console.log(result); //result2
        });
      });
    });

arguments

  • str: Name of the model method e.g 'find'
  • arr: Array of mock results

clearResults()

Clears all mock results.

setErrors(str, arr)

Sets mock errors for an specific model method call. Results are returned depending the order defined in the array. If there's only one error left it will always return that as error.

Example

  Model.setErrors('find', ['error1', 'error2']);
  //first call
  Model.find({})
    .execute(function(err, result){
      console.log(err); // error1
      //second call
      Model.find({})
      .execute(function(err, result){
        console.log(err); //error2
        //third call
        Model.find({}, function(err, result){
          console.log(err); //err2
        });
      });
    });

arguments

  • str: Name of the model method e.g 'find'
  • arr: Array of mock errors

clearErrors()

Clears all mocked errors.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100