Interface File

File

Describes changes to a file

interface File {
    changeType:
        | "ADDED"
        | "COPIED"
        | "DELETED"
        | "MODIFIED"
        | "MOVED"
        | "UNKNOWN";
    linesAdded: number;
    linesRemoved: number;
    path: string;
    url: string;
}

Hierarchy

  • Record<string, unknown>
    • File

Properties

changeType linesAdded linesRemoved path url

Properties

changeType

changeType:
    | "ADDED"
    | "COPIED"
    | "DELETED"
    | "MODIFIED"
    | "MOVED"
    | "UNKNOWN"

The operation performed on this file

Example

MODIFIED

linesAdded

linesAdded: number

Number of lines added to the file

Example

0

linesRemoved

linesRemoved: number

Number of lines removed from the file

Example

1

path

path: string

The path of the file. Max length is 1024 characters.

Example

/home/user/src/atlassian-connect-jira-example/README.md

url

url: string

The URL of this file. Max length is 2000 characters.

Example

https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md

Settings

Member Visibility

On This Page

Properties