Skip to content
Open
Changes from all commits
Commits
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
52 changes: 52 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
declare module "ot-diff" {
class Diff {
/**
* Generates the diff.
* @param oldString
* @param newString
* @param raw
*/
public diff(oldString: string, newString: string, raw?: boolean): OtDiff;

/**
* Applies a transform (`insert`, `delete`, `replace` or `noop`) based on the value of diff.action.
*/
public transform(value: string, transform: OtDiff): string;
public insert(value: string, transform: OtDiff): string;
public delete(value: string, transform: OtDiff): string;
public replace(value: string, transform: OtDiff): string;
public noop(value: string, transform: OtDiff): string;
}

export interface OtOpts {
newString: string;
oldString: string;
raw: boolean;
changeStart: number;
changeFromEnd: number;
changeEndIndexNew: number;
changeEndIndexOld: number;
charsAdded: number;
charsRemoved: number;
}

export type OtDiff = ({
action: 'insert',
start: number,
payload: string
} | {
action: 'delete',
start: number,
remove: number
} | {
action: 'replace',
start: number,
remove: number,
payload: string
} | {
action: 'noop'
}) & { opts?: OtOpts };

const diff: Diff;
export default diff;
}