| 1 | /* |
| 2 | Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/ |
| 3 | |
| 4 | This program is free software; |
| 5 | you can redistribute it and/or modify it under the terms of the |
| 6 | GNU General Public License as published by the Free Software Foundation; |
| 7 | either version 3 of the License, or any later version. |
| 8 | |
| 9 | This program is distributed in the hope that it will be useful, |
| 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | GNU General Public License for more details. |
| 13 | |
| 14 | You should have received a copy of the GNU General Public License |
| 15 | along with this program; if not, write to the Free Software |
| 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 17 | */ |
| 18 | /* |
| 19 | Changes: |
| 20 | - v4.0.0: |
| 21 | - created from v3.6.0 |
| 22 | Doc reviewed 202208 |
| 23 | */ |
| 24 | |
| 25 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
| 26 | /** |
| 27 | A simple container to store a provider name and a provider api key |
| 28 | */ |
| 29 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
| 30 | |
| 31 | class ApiKey { |
| 32 | |
| 33 | /** |
| 34 | The provider name |
| 35 | @type {String} |
| 36 | */ |
| 37 | |
| 38 | #providerName; |
| 39 | |
| 40 | /** |
| 41 | The provider api key |
| 42 | @type {String} |
| 43 | */ |
| 44 | |
| 45 | #providerKey; |
| 46 | |
| 47 | /** |
| 48 | The constructor |
| 49 | @param {String} providerName The provider name |
| 50 | @param {String} providerKey The provider api key |
| 51 | */ |
| 52 | |
| 53 | constructor ( providerName, providerKey ) { |
| 54 | Object.freeze ( this ); |
| 55 | this.#providerName = 'string' === typeof ( providerName ) ? providerName : ''; |
| 56 | this.#providerKey = 'string' === typeof ( providerKey ) ? providerKey : ''; |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | The provider name |
| 61 | @type {String} |
| 62 | */ |
| 63 | |
| 64 | get providerName ( ) { return this.#providerName; } |
| 65 | |
| 66 | /** |
| 67 | The provider api key |
| 68 | @type {String} |
| 69 | */ |
| 70 | |
| 71 | get providerKey ( ) { return this.#providerKey; } |
| 72 | |
| 73 | /** |
| 74 | An object literal with the ApiKey properties and without any methods. |
| 75 | This object can be used with the JSON object |
| 76 | @type {JsonObject} |
| 77 | */ |
| 78 | |
| 79 | get jsonObject ( ) { return { providerName : this.providerName, providerKey : this.providerKey }; } |
| 80 | |
| 81 | } |
| 82 | |
| 83 | export default ApiKey; |
| 84 | |
| 85 | /* --- End of file --------------------------------------------------------------------------------------------------------- */ |
| 86 |