Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeleteFileOptions

DeleteFileOptions options for deleting files (used for other File structs below) Note: author and committer are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)

export
interface

DeleteFileOptions

Hierarchy

  • DeleteFileOptions

Index

Properties

author?: Identity
memberof

DeleteFileOptions

branch?: string

branch (optional) to base this file from. if not given, the default branch is used

memberof

DeleteFileOptions

committer?: Identity
memberof

DeleteFileOptions

memberof

DeleteFileOptions

message?: string

message (optional) for the commit of this file. if not supplied, a default message will be used

memberof

DeleteFileOptions

new_branch?: string

new_branch (optional) will make a new branch from branch before creating the file

memberof

DeleteFileOptions

sha: string

sha is the SHA for the file that already exists

memberof

DeleteFileOptions

signoff?: boolean

Add a Signed-off-by trailer by the committer at the end of the commit log message.

memberof

DeleteFileOptions

Generated using TypeDoc