mirror of
https://github.com/sindresorhus/type-fest.git
synced 2025-12-08 19:25:05 +00:00
34 lines
953 B
TypeScript
34 lines
953 B
TypeScript
/**
|
|
Matches a JSON object.
|
|
|
|
This type can be useful to enforce some input to be JSON-compatible or as a super-type to be extended from. Don't use this as a direct return type as the user would have to double-cast it: `jsonObject as unknown as CustomResponse`. Instead, you could extend your CustomResponse type from it to ensure your type only uses JSON-compatible types: `interface CustomResponse extends JsonObject { … }`.
|
|
|
|
@category JSON
|
|
*/
|
|
export type JsonObject = {[Key in string]: JsonValue};
|
|
|
|
/**
|
|
Matches a JSON array.
|
|
|
|
@category JSON
|
|
*/
|
|
export type JsonArray = JsonValue[] | readonly JsonValue[];
|
|
|
|
/**
|
|
Matches any valid JSON primitive value.
|
|
|
|
@category JSON
|
|
*/
|
|
export type JsonPrimitive = string | number | boolean | null;
|
|
|
|
/**
|
|
Matches any valid JSON value.
|
|
|
|
@see `Jsonify` if you need to transform a type to one that is assignable to `JsonValue`.
|
|
|
|
@category JSON
|
|
*/
|
|
export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
|
|
|
|
export {};
|