mailslurp-client/test/_helpers.ts

Official client for MailSlurp Email and SMS API. Create email addresses and phone numbers in Javascript without a mail server. Send and receive real emails in applications or tests.

import { MailSlurp } from '../dist';

/**
 * Helper function to run a test with a configured mailslurp client if an API_KEY env variable is present
 */
export function integrationTest(
  name: string,
  fn: (mailslurp: MailSlurp) => Promise<any>
) {
  const apiKey = process.env.API_KEY;
  test(name, async () => {
    if (apiKey && apiKey.length > 0) {
      await fn(new MailSlurp({ apiKey }));
    } else {
      console.warn('Skipping test with api key API KEY missing');
    }
  });
}
export function phoneTest(
  name: string,
  fn: (mailslurp: MailSlurp) => Promise<any>
) {
  const apiKey = process.env.PHONE_KEY;
  const testId = process.env.TEST_ID;
  const headers = testId ? { 'x-test-id': testId } : undefined;
  test(name, async () => {
    if (apiKey && apiKey.length > 0) {
      await fn(new MailSlurp({ apiKey, headers }));
    } else {
      console.warn('Skipping test with api key PHONE KEY missing');
    }
  });
}