AWS SDK Vitest Mock - API Reference - v1.0.6
    Preparing search index...

    Function mockClient

    • Create a mock for an AWS SDK client class.

      Use this function when you want to mock all instances of a client class.

      Type Parameters

      • TClient extends AnyClient

      Parameters

      • clientConstructor: ClientConstructor<TClient>

        The AWS SDK client class to mock

      Returns AwsClientStub<TClient>

      A client stub for configuring mock behaviors

      import { S3Client, GetObjectCommand } from '@aws-sdk/client-s3';
      import { mockClient } from 'aws-sdk-vitest-mock';

      const s3Mock = mockClient(S3Client);

      s3Mock.on(GetObjectCommand).resolves({ Body: 'file contents' });

      const client = new S3Client({});
      const result = await client.send(new GetObjectCommand({ Bucket: 'my-bucket', Key: 'file.txt' }));
      // result.Body === 'file contents'