caniemail
Version:
HTML and CSS Feature Support for Email Clients from caniemail.com
28 lines • 959 B
TypeScript
import { type EmailClient, type EmailClientGlobs } from './clients.js';
import { type FeatureIssue, type FeatureIssues } from './features.js';
export * from './helpers.js';
export { getAllFeatures, rawData } from './features.js';
export interface CanIEmailOptions {
/**
An array of client names or globs to match email clients.
Example: ['gmail.android', 'outlook.*', '*.ios']
*/
clients: EmailClientGlobs[];
css?: string;
html?: string;
}
export interface CanIEmailResult {
issues: FeatureIssues;
success: boolean;
}
interface FormatIssueOptions {
client: EmailClient;
issue: FeatureIssue;
issueType: 'error' | 'warning';
}
export declare const caniemail: ({ clients: globs, css, html }: CanIEmailOptions) => CanIEmailResult;
export declare const formatIssue: ({ client, issue, issueType }: FormatIssueOptions) => {
message: string;
notes: string[];
};
//# sourceMappingURL=index.d.ts.map