Skip to content

feat(types): add JSONPatchFormatter #316

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

feat(types): add JSONPatchFormatter #316

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1a3375
feat(types): add JSONPatchFormatter
marcolink Dec 18, 2021
d45955a
Update index.d.ts
marcolink Dec 20, 2021
b7b62a5
Merge branch 'master' into master
Methuselah96 Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,34 @@ export interface HtmlFormatter extends Formatter {
hideUnchanged(node?: Element | null, delay?: number): void;
}

type AddOperation = {
opp: string;
Copy link
Collaborator

@Methuselah96 Methuselah96 Aug 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like these should be op and not opp (on all the operations)?

path: string;
value: any
}

type RemoveOperation = {
opp: string;
path: string;
}

type ReplaceOperation = {
opp: string;
path: string;
value: any;
}

type MoveOperation = {
opp: string;
path: string;
}

export type Operation = AddOperation | RemoveOperation | ReplaceOperation | MoveOperation

export interface JSONPatchFormatter {
Copy link
Collaborator

@Methuselah96 Methuselah96 Aug 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally JSONPatchFormatter would inherit from Formatter, but we can handle that in a future PR.

format(delta: Delta, original: any): Operation[];
}

export interface Delta {
[key: string]: any;
[key: number]: any;
Expand Down Expand Up @@ -190,6 +218,7 @@ export const formatters: {
annotated: Formatter;
console: Formatter;
html: HtmlFormatter;
jsonpatch: JSONPatchFormatter;
};

export const console: Formatter
Expand Down