Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpdateFileOptions

UpdateFileOptions options for updating files 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

UpdateFileOptions

Hierarchy

  • UpdateFileOptions

Index

Properties

author?: Identity
memberof

UpdateFileOptions

branch?: string

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

memberof

UpdateFileOptions

committer?: Identity
memberof

UpdateFileOptions

content: string

content must be base64 encoded

memberof

UpdateFileOptions

memberof

UpdateFileOptions

from_path?: string

from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL

memberof

UpdateFileOptions

message?: string

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

memberof

UpdateFileOptions

new_branch?: string

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

memberof

UpdateFileOptions

sha: string

sha is the SHA for the file that already exists

memberof

UpdateFileOptions

signoff?: boolean

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

memberof

UpdateFileOptions

Generated using TypeDoc