to be fulfilled with value satisfying

• <Promise> to be fulfilled with value [exhaustively] satisfying <any>

Asserts that a promise is fulfilled with a specific value:

const promiseThatWillBeFulfilledWithAValue = new Promise(function (
  resolve,
  reject
) {
  setTimeout(function () {
    resolve({
      foo: 'bar',
    });
  }, 1);
});
 
return expect(
  promiseThatWillBeFulfilledWithAValue,
  'to be fulfilled with value satisfying',
  { foo: 'bar' }
);

The expected value will be matched against the value with to satisfy semantics, so you can pass any of the values supported by to satisfy:

return expect(
  Promise.resolve('abc'),
  'to be fulfilled with value satisfying',
  /b/
);

You get a nice diff if the assertion fails:

return expect(
  Promise.resolve('abc'),
  'to be fulfilled with value satisfying',
  'def'
);

expected Promise to be fulfilled with value satisfying 'def'
  
expected 'abc' to equal 'def'
 
abc
def

You can use the exhaustively flag to use strict to satisfy semantics:

return expect(
  Promise.resolve({
    foo: 'foo',
    bar: 'bar',
  }),
  'to be fulfilled with value exhaustively satisfying',
  {
    foo: 'foo',
  }
);

expected Promise to be fulfilled with value exhaustively satisfying { foo: 'foo' }
  
expected { foo: 'foo', bar: 'bar' } to exhaustively satisfy { foo: 'foo' }
 
{
  
foo: 'foo',
  
bar: 'bar' 
//
 
should be removed
}