Class CommandBehavior<TInput, TOutput, TCommandOutput, TConfiguration>

Sets a function that will be called on Client#send() invocation for the current Command.

Example

snsMock
  .on(PublishCommand)
  .callsFake(input => {
    if (input.Message === 'My message') {
      return {MessageId: '111'};
    } else {
      throw new Error('mocked rejection');
    }
  });
Copy

Example

Result based on the Client configuration:

snsMock
  .on(PublishCommand)
  .callsFake(async (input, getClient) => {
    const client = getClient();
    const region = await client.config.region();
    return {MessageId: region.substring(0, 2)};
  });
Copy

Sets a function that will be called once on Client#send() invocation for the current Command.

Can be chained so that successive invocations call different functions. When there are no more callsFakeOnce() functions to use, invocations will call a function specified by callsFake().

Example

snsMock
  .on(PublishCommand)
  .callsFakeOnce(cmd => {MessageId: '111'}) // first call
  .callsFakeOnce(cmd => {MessageId: '222'}) // second call
  .callsFake(cmd => {MessageId: '000'}); // default
Copy

Deprecated

Using this method means that the previously set .on(Command) was not followed by resolves/rejects/callsFake call. If this is legitimate behavior, please open an issue with your use case.

Deprecated

Using this method means that the previously set .on(Command) was not followed by resolves/rejects/callsFake call. If this is legitimate behavior, please open an issue with your use case.

Sets a failure response that will be returned from Client#send() invocation for the current Command. The response will always be an Error instance.

Example

snsMock
  .on(PublishCommand)
  .rejects('mocked rejection');
Copy

Example

const throttlingError = new Error('mocked rejection');
throttlingError.name = 'ThrottlingException';
snsMock
  .on(PublishCommand)
  .rejects(throttlingError);
Copy

Sets a failure response that will be returned from one Client#send() invocation for the current Command. The response will always be an Error instance.

Can be chained so that successive invocations return different responses. When there are no more rejectsOnce() responses to use, invocations will return a response specified by rejects().

Example

snsMock
  .on(PublishCommand)
  .rejectsOnce('first mocked rejection')
  .rejectsOnce('second mocked rejection')
  .rejects('default mocked rejection');
Copy

Sets a successful response that will be returned from Client#send() invocation for the current Command.

Example

snsMock
  .on(PublishCommand)
  .resolves({MessageId: '111'});
Copy

Sets a successful response that will be returned from one Client#send() invocation for the current Command.

Can be chained so that successive invocations return different responses. When there are no more resolvesOnce() responses to use, invocations will return a response specified by resolves().

Example

snsMock
  .on(PublishCommand)
  .resolvesOnce({MessageId: '111'}) // first call
  .resolvesOnce({MessageId: '222'}) // second call
  .resolves({MessageId: '333'}); // default
Copy