import type {JsonPrimitive, JsonValue} from './basic'; import type {EmptyObject} from './empty-object'; import type {UndefinedToOptional} from './internal'; import type {IsAny} from './is-any'; import type {IsNever} from './is-never'; import type {IsUnknown} from './is-unknown'; import type {NegativeInfinity, PositiveInfinity} from './numeric'; import type {TypedArray} from './typed-array'; import type {UnknownArray} from './unknown-array'; // Note: The return value has to be `any` and not `unknown` so it can match `void`. type NotJsonable = ((...arguments_: any[]) => any) | undefined | symbol; type NeverToNull = IsNever extends true ? null : T; type UndefinedToNull = T extends undefined ? null : T; // Handles tuples and arrays type JsonifyList = T extends readonly [] ? [] : T extends readonly [infer F, ...infer R] ? [NeverToNull>, ...JsonifyList] : IsUnknown extends true ? [] : Array>>; type FilterJsonableKeys = { [Key in keyof T]: T[Key] extends NotJsonable ? never : Key; }[keyof T]; /** JSON serialize objects (not including arrays) and classes. */ type JsonifyObject = { [Key in keyof Pick>]: Jsonify; }; /** Transform a type to one that is assignable to the `JsonValue` type. This includes: 1. Transforming JSON `interface` to a `type` that is assignable to `JsonValue`. 2. Transforming non-JSON value that is *jsonable* to a type that is assignable to `JsonValue`, where *jsonable* means the non-JSON value implements the `.toJSON()` method that returns a value that is assignable to `JsonValue`. @remarks An interface cannot be structurally compared to `JsonValue` because an interface can be re-opened to add properties that may not be satisfy `JsonValue`. @example ``` import type {Jsonify, JsonValue} from 'type-fest'; interface Geometry { type: 'Point' | 'Polygon'; coordinates: [number, number]; } const point: Geometry = { type: 'Point', coordinates: [1, 1] }; const problemFn = (data: JsonValue) => { // Does something with data }; problemFn(point); // Error: type Geometry is not assignable to parameter of type JsonValue because it is an interface const fixedFn = (data: Jsonify) => { // Does something with data }; fixedFn(point); // Good: point is assignable. Jsonify transforms Geometry into value assignable to JsonValue fixedFn(new Date()); // Error: As expected, Date is not assignable. Jsonify cannot transforms Date into value assignable to JsonValue ``` Non-JSON values such as `Date` implement `.toJSON()`, so they can be transformed to a value assignable to `JsonValue`: @example ``` import type {Jsonify} from 'type-fest'; const time = { timeValue: new Date() }; // `Jsonify` is equivalent to `{timeValue: string}` const timeJson = JSON.parse(JSON.stringify(time)) as Jsonify; ``` @link https://github.com/Microsoft/TypeScript/issues/1897#issuecomment-710744173 @category JSON */ export type Jsonify = IsAny extends true ? any : T extends PositiveInfinity | NegativeInfinity ? null : T extends JsonPrimitive ? T : // Any object with toJSON is special case T extends {toJSON(): infer J} ? (() => J) extends () => JsonValue // Is J assignable to JsonValue? ? J // Then T is Jsonable and its Jsonable value is J : Jsonify // Maybe if we look a level deeper we'll find a JsonValue : // Instanced primitives are objects T extends Number ? number : T extends String ? string : T extends Boolean ? boolean : T extends Map | Set ? EmptyObject : T extends TypedArray ? Record : T extends NotJsonable ? never // Non-JSONable type union was found not empty : T extends UnknownArray ? JsonifyList : T extends object ? JsonifyObject> // JsonifyObject recursive call for its children : never; // Otherwise any other non-object is removed