aboutsummaryrefslogtreecommitdiff
path: root/ext/js/core/json.js
blob: c7d8fbfd1d22e266fd8e635df4fa7dada107ee74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

/**
 * This function is used to ensure more safe usage of `JSON.parse`.
 * By default, `JSON.parse` returns a value with type `any`, which is easy to misuse.
 * By changing the default to `unknown` and allowing it to be templatized,
 * this improves how the return type is used.
 * @template [T=unknown]
 * @param {string} value
 * @returns {T}
 */
export function parseJson(value) {
    // eslint-disable-next-line no-restricted-syntax
    return JSON.parse(value);
}

/**
 * This function is used to ensure more safe usage of `Response.json`,
 * which returns the `any` type.
 * @template [T=unknown]
 * @param {Response} response
 * @returns {Promise<T>}
 */
export async function readResponseJson(response) {
    // eslint-disable-next-line no-restricted-syntax
    return await response.json();
}