forked from Rowland/EG
61 lines
1.6 KiB
TypeScript
61 lines
1.6 KiB
TypeScript
import { AbstractMatchConfig, AbstractMatch } from './abstract-match';
|
|
/**
|
|
* @class Autolinker.match.Email
|
|
* @extends Autolinker.match.AbstractMatch
|
|
*
|
|
* Represents a Email match found in an input string which should be Autolinked.
|
|
*
|
|
* See this class's superclass ({@link Autolinker.match.Match}) for more details.
|
|
*/
|
|
export declare class EmailMatch extends AbstractMatch {
|
|
/**
|
|
* @public
|
|
* @property {'email'} type
|
|
*
|
|
* A string name for the type of match that this class represents. Can be
|
|
* used in a TypeScript discriminating union to type-narrow from the
|
|
* `Match` type.
|
|
*/
|
|
readonly type: "email";
|
|
/**
|
|
* @cfg {String} email (required)
|
|
*
|
|
* The email address that was matched.
|
|
*/
|
|
private readonly email;
|
|
/**
|
|
* @method constructor
|
|
* @param {Object} cfg The configuration properties for the Match
|
|
* instance, specified in an Object (map).
|
|
*/
|
|
constructor(cfg: EmailMatchConfig);
|
|
/**
|
|
* Returns a string name for the type of match that this class represents.
|
|
* For the case of EmailMatch, returns 'email'.
|
|
*
|
|
* @return {String}
|
|
*/
|
|
getType(): 'email';
|
|
/**
|
|
* Returns the email address that was matched.
|
|
*
|
|
* @return {String}
|
|
*/
|
|
getEmail(): string;
|
|
/**
|
|
* Returns the anchor href that should be generated for the match.
|
|
*
|
|
* @return {String}
|
|
*/
|
|
getAnchorHref(): string;
|
|
/**
|
|
* Returns the anchor text that should be generated for the match.
|
|
*
|
|
* @return {String}
|
|
*/
|
|
getAnchorText(): string;
|
|
}
|
|
export interface EmailMatchConfig extends AbstractMatchConfig {
|
|
email: string;
|
|
}
|