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

    Function mockClientInstance

    • Create a mock for a specific AWS SDK client instance.

      Use this function when you want to mock a single client instance.

      Type Parameters

      • TClient extends AnyClient

      Parameters

      • clientInstance: TClient

        The AWS SDK client instance to mock

      Returns AwsClientStub<AnyClient>

      A client stub for configuring mock behaviors

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

      const client = new S3Client({});
      const s3Mock = mockClientInstance(client);

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

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