@flex-development/tutils/dist/types/json-object.d.mts

TypeScript utilities

/**
 * @file Type Definitions - JSONObject
 * @module tutils/types/JSONObject
 */
import type JSONValue from './json-value.mjs';
/**
 * Type representing a [JSON][1] object.
 *
 * This type can be used to enforce input values to be JSON-compatible or as a
 * super-type to be extended from.
 *
 * The type should **not**, however, be used as a direct return type as the user
 * would have to double-cast it: `object as unknown as CustomResponse`.
 *
 * Instead, the return type should extend `JSONObject` to ensure the return type
 * is JSON-compatible: `interface CustomResponse extends JSONObject { … }`.
 *
 * [1]: https://restfulapi.net/json-data-types
 */
declare type JSONObject = {
    [K in string]?: JSONValue;
};
export { type JSONObject as default };