Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delta type is too wide #368

Open
samhh opened this issue May 2, 2024 · 0 comments
Open

Delta type is too wide #368

samhh opened this issue May 2, 2024 · 0 comments

Comments

@samhh
Copy link

samhh commented May 2, 2024

Between 0.5 and 0.6 the Delta type returned by diff changed. It used to be:

export interface Delta {
    [key: string]: any;
    [key: number]: any;
}

Now it's:

export type Delta = AddedDelta | ModifiedDelta | DeletedDelta | ObjectDelta | ArrayDelta | MovedDelta | TextDiffDelta | undefined;

Where many of those are typed partially with unknown.

This is undoubtedly an improvement, however I wonder if we could narrow unknown down at all?

My use case is trying to work with JSON safely , for example via fp-ts' Json type: https://github.com/gcanti/fp-ts/blob/2.16.5/src/Json.ts#L10.

export type Json = boolean | number | string | null | JsonArray | JsonRecord

This enables infallible stringification.

I suspect Delta is already implicitly a subtype of Json, however if not it'd be good to know that. Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant