source: node_modules/autolinker/dist/es2015/match/email-match.d.ts

main
Last change on this file was d24f17c, checked in by Aleksandar Panovski <apano77@…>, 15 months ago

Initial commit

  • Property mode set to 100644
File size: 1.3 KB
RevLine 
[d24f17c]1import { Match, MatchConfig } from './match';
2/**
3 * @class Autolinker.match.Email
4 * @extends Autolinker.match.Match
5 *
6 * Represents a Email match found in an input string which should be Autolinked.
7 *
8 * See this class's superclass ({@link Autolinker.match.Match}) for more details.
9 */
10export declare class EmailMatch extends Match {
11 /**
12 * @cfg {String} email (required)
13 *
14 * The email address that was matched.
15 */
16 private readonly email;
17 /**
18 * @method constructor
19 * @param {Object} cfg The configuration properties for the Match
20 * instance, specified in an Object (map).
21 */
22 constructor(cfg: EmailMatchConfig);
23 /**
24 * Returns a string name for the type of match that this class represents.
25 * For the case of EmailMatch, returns 'email'.
26 *
27 * @return {String}
28 */
29 getType(): string;
30 /**
31 * Returns the email address that was matched.
32 *
33 * @return {String}
34 */
35 getEmail(): string;
36 /**
37 * Returns the anchor href that should be generated for the match.
38 *
39 * @return {String}
40 */
41 getAnchorHref(): string;
42 /**
43 * Returns the anchor text that should be generated for the match.
44 *
45 * @return {String}
46 */
47 getAnchorText(): string;
48}
49export interface EmailMatchConfig extends MatchConfig {
50 email: string;
51}
Note: See TracBrowser for help on using the repository browser.