File : core/htmlSanitizer/UrlValidationResult.js

1
2
/*
3
Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/
4
5
This  program is free software;
6
you can redistribute it and/or modify it under the terms of the
7
GNU General Public License as published by the Free Software Foundation;
8
either version 3 of the License, or any later version.
9
10
This program is distributed in the hope that it will be useful,
11
but WITHOUT ANY WARRANTY; without even the implied warranty of
12
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
GNU General Public License for more details.
14
15
You should have received a copy of the GNU General Public License
16
along with this program; if not, write to the Free Software
17
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
*/
19
20
/*
21
Changes:
22
Doc reviewed ...
23
Tests ...
24
*/
25
/* ------------------------------------------------------------------------------------------------------------------------- */
26
/**
27
An object returned by the sanitizeToUrl function
28
*/
29
/* ------------------------------------------------------------------------------------------------------------------------- */
30
31
class UrlValidationResult {
32
33
    /**
34
    The validated url or an empty string if the url is invalid
35
    @type {String}
36
    */
37
38
    #url;
39
40
    /**
41
    An empty string or an error description if the url is invalid
42
    @type {String}
43
    */
44
45
    #errorsString;
46
47
    /**
48
    The constructor
49
    @param {String} url The validated url or an empty string if the url is invalid
50
    @param {String} errorsString An empty string or an error description if the url is invalid
51
    */
52
53
    constructor ( url, errorsString ) {
54
        Object.freeze ( this );
55
        this.#url = url;
56
        this.#errorsString = errorsString;
57
    }
58
59
    /**
60
    The validated url or an empty string if the url is invalid
61
    @type {String}
62
    */
63
64
    get url ( ) { return this.#url; }
65
66
    /**
67
    An empty string or an error description if the url is invalid
68
    @type {String}
69
    */
70
71
    get errorsString ( ) { return this.#errorsString; }
72
}
73
74
export default UrlValidationResult;
75
76
/* --- End of file --------------------------------------------------------------------------------------------------------- */
77