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

Improved index.d.ts to utilize generics that reflect the recursive transformation of array field types into object types #99

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
49 changes: 39 additions & 10 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,44 @@
export function diff (originalObj: object, updatedObj: object): object
type Primitive = string | number | boolean | null | undefined;

export function addedDiff (originalObj: object, updatedObj: object): object
export type Diff<T> = T extends Primitive
? T
: T extends Array<infer U>
? { [key: string]: Diff<U> }
: { [P in keyof T]?: Diff<T[P]> };

export function deletedDiff (originalObj: object, updatedObj: object): object
export type DiffRemovable<T> = T extends Primitive
? T
: T extends Array<infer U>
? { [key: string]: DiffRemovable<U | undefined> }
: { [P in keyof T]?: DiffRemovable<T[P]> };

export function updatedDiff (originalObj: object, updatedObj: object): object
export function diff<T extends object>(
originalObj: T,
updatedObj: T,
): DiffRemovable<T>;

export interface DetailedDiff {
added: object
deleted: object
updated: object
}
export function addedDiff<T extends object>(
originalObj: T,
updatedObj: T,
): Diff<T>;

export function detailedDiff (originalObj: object, updatedObj: object): DetailedDiff
export function deletedDiff<T extends object>(
originalObj: T,
updatedObj: T,
): DiffRemovable<T>;

export function updatedDiff<T extends object>(
originalObj: T,
updatedObj: T,
): Diff<T>;

export type DetailedDiff<T> = {
added: Diff<T>;
deleted: DiffRemovable<T>;
updated: Diff<T>;
};

export function detailedDiff<T extends object>(
originalObj: T,
updatedObj: T,
): DetailedDiff<T>;