index.md

layout	default
menu_item	api
title	ConvenientPatch
description	Version 0.26.1
return_to	API Documentation Index /api/
sections	#hunks #isAdded #isConflicted #isCopied #isDeleted #isIgnored #isModified #isRenamed #isTypeChange #isUnmodified #isUnreadable #isUntracked #lineStats #newFile #oldFile #size #status #hunks #isAdded #isConflicted #isCopied #isDeleted #isIgnored #isModified #isRenamed #isTypeChange #isUnmodified #isUnreadable #isUntracked #lineStats #newFile #oldFile #size #status

ConvenientPatch#hunks Async

convenientPatch.hunks().then(function(arrayConvenientHunk) {
  // Use arrayConvenientHunk
});

The hunks in this patch

Returns
Array<ConvenientHunk>	a promise that resolves to an array of ConvenientHunks

ConvenientPatch#isAdded Sync

var boolean = convenientPatch.isAdded();

Is this an added patch?

Returns
Boolean

ConvenientPatch#isConflicted Sync

var boolean = convenientPatch.isConflicted();

Is this a conflicted patch?

Returns
Boolean

ConvenientPatch#isCopied Sync

var boolean = convenientPatch.isCopied();

Is this a copied patch?

Returns
Boolean

ConvenientPatch#isDeleted Sync

var boolean = convenientPatch.isDeleted();

Is this a deleted patch?

Returns
Boolean

ConvenientPatch#isIgnored Sync

var boolean = convenientPatch.isIgnored();

Is this an ignored patch?

Returns
Boolean

ConvenientPatch#isModified Sync

var boolean = convenientPatch.isModified();

Is this an modified patch?

Returns
Boolean

ConvenientPatch#isRenamed Sync

var boolean = convenientPatch.isRenamed();

Is this a renamed patch?

Returns
Boolean

ConvenientPatch#isTypeChange Sync

var boolean = convenientPatch.isTypeChange();

Is this a type change?

Returns
Boolean

ConvenientPatch#isUnmodified Sync

var boolean = convenientPatch.isUnmodified();

Is this an unmodified patch?

Returns
Boolean

ConvenientPatch#isUnreadable Sync

var boolean = convenientPatch.isUnreadable();

Is this an undreadable patch?

Returns
Boolean

ConvenientPatch#isUntracked Sync

var boolean = convenientPatch.isUntracked();

Is this an untracked patch?

Returns
Boolean

ConvenientPatch#lineStats Sync

var lineStats = convenientPatch.lineStats();

The line statistics of this patch (#contexts, #added, #deleted)

Returns
lineStats

ConvenientPatch#newFile Sync

var diffFile = convenientPatch.newFile();

New attributes of the file

Returns
DiffFile

ConvenientPatch#oldFile Sync

var diffFile = convenientPatch.oldFile();

Old attributes of the file

Returns
DiffFile

ConvenientPatch#size Sync

var number = convenientPatch.size();

The number of hunks in this patch

Returns
Number

ConvenientPatch#status Sync

var number = convenientPatch.status();

The status of this patch (unmodified, added, deleted)

Returns
Number