Variable matchersConst

Type Declaration

• toHaveReceivedCommand: function

  • toHaveReceivedCommand<TInput extends object, TOutput extends MetadataBearer>(
        received: AwsClientStub,
        command: CommandConstructor<TInput, TOutput>,
    ): MatcherResult

    Assert that a command was received at least once.

    Type Parameters

    • TInput extends object
    • TOutput extends MetadataBearer

    Parameters

    • received: AwsClientStub

      The AWS client stub

    • command: CommandConstructor<TInput, TOutput>

      The command constructor to check for

    Returns MatcherResult

    Matcher result

    Example

    const s3Mock = mockClient(S3Client);
    const client = new S3Client({});
    
    await client.send(new GetObjectCommand({ Bucket: 'test', Key: 'file.txt' }));
    
    expect(s3Mock).toHaveReceivedCommand(GetObjectCommand);
    Copy

• toHaveReceivedCommandTimes: function

  • toHaveReceivedCommandTimes<
        TInput extends object,
        TOutput extends MetadataBearer,
    >(
        received: AwsClientStub,
        command: CommandConstructor<TInput, TOutput>,
        times: number,
    ): MatcherResult

    Assert that a command was received exactly N times.

    Type Parameters

    • TInput extends object
    • TOutput extends MetadataBearer

    Parameters

    • received: AwsClientStub

      The AWS client stub

    • command: CommandConstructor<TInput, TOutput>

      The command constructor to check for

    • times: number

      The exact number of times the command should have been received

    Returns MatcherResult

    Matcher result

    Example

    const s3Mock = mockClient(S3Client);
    const client = new S3Client({});
    
    await client.send(new GetObjectCommand({ Bucket: 'test', Key: 'file1.txt' }));
    await client.send(new GetObjectCommand({ Bucket: 'test', Key: 'file2.txt' }));
    
    expect(s3Mock).toHaveReceivedCommandTimes(GetObjectCommand, 2);
    Copy

• toHaveReceivedCommandWith: function

  • toHaveReceivedCommandWith<TInput extends object, TOutput extends MetadataBearer>(
        this: { equals: (a: unknown, b: unknown) => boolean },
        received: AwsClientStub,
        command: CommandConstructor<TInput, TOutput>,
        input: TInput,
    ): MatcherResult

    Assert that a command was received with specific input parameters.

    Type Parameters

    • TInput extends object
    • TOutput extends MetadataBearer

    Parameters

    • this: { equals: (a: unknown, b: unknown) => boolean }
    • received: AwsClientStub

      The AWS client stub

    • command: CommandConstructor<TInput, TOutput>

      The command constructor to check for

    • input: TInput

      The expected input parameters

    Returns MatcherResult

    Matcher result

    Example

    const s3Mock = mockClient(S3Client);
    const client = new S3Client({});
    
    await client.send(new GetObjectCommand({ Bucket: 'test', Key: 'file.txt' }));
    
    expect(s3Mock).toHaveReceivedCommandWith(GetObjectCommand, {
      Bucket: 'test',
      Key: 'file.txt'
    });
    Copy

• toHaveReceivedNthCommandWith: function

  • toHaveReceivedNthCommandWith<
        TInput extends object,
        TOutput extends MetadataBearer,
    >(
        this: { equals: (a: unknown, b: unknown) => boolean },
        received: AwsClientStub,
        n: number,
        command: CommandConstructor<TInput, TOutput>,
        input: TInput,
    ): MatcherResult

    Assert that the Nth command call was a specific command with specific input.

    Type Parameters

    • TInput extends object
    • TOutput extends MetadataBearer

    Parameters

    • this: { equals: (a: unknown, b: unknown) => boolean }
    • received: AwsClientStub

      The AWS client stub

    • n: number

      The call number (1-indexed)

    • command: CommandConstructor<TInput, TOutput>

      The command constructor to check for

    • input: TInput

      The expected input parameters

    Returns MatcherResult

    Matcher result

    Example

    const s3Mock = mockClient(S3Client);
    const client = new S3Client({});
    
    await client.send(new PutObjectCommand({ Bucket: 'test', Key: 'file1.txt' }));
    await client.send(new GetObjectCommand({ Bucket: 'test', Key: 'file2.txt' }));
    
    expect(s3Mock).toHaveReceivedNthCommandWith(2, GetObjectCommand, {
      Bucket: 'test',
      Key: 'file2.txt'
    });
    Copy

• toHaveReceivedNoOtherCommands: function

  • toHaveReceivedNoOtherCommands<
        TInput extends object,
        TOutput extends MetadataBearer,
    >(
        received: AwsClientStub,
        expectedCommands?: CommandConstructor<TInput, TOutput>[],
    ): MatcherResult

    Assert that no commands other than the expected ones were received.

    Type Parameters

    • TInput extends object
    • TOutput extends MetadataBearer

    Parameters

    • received: AwsClientStub

      The AWS client stub

    • expectedCommands: CommandConstructor<TInput, TOutput>[] = []

      Array of command constructors that are allowed

    Returns MatcherResult

    Matcher result

    Example

    const s3Mock = mockClient(S3Client);
    const client = new S3Client({});
    
    await client.send(new GetObjectCommand({ Bucket: 'test', Key: 'file.txt' }));
    await client.send(new GetObjectCommand({ Bucket: 'test', Key: 'other.txt' }));
    
    expect(s3Mock).toHaveReceivedNoOtherCommands([GetObjectCommand]);
    Copy