Skip to main content

git-sync-js / commitAndSync / ICommitAndSyncOptions

Interface: ICommitAndSyncOptions

commitAndSync.ICommitAndSyncOptions

Table of contents​

Properties​

Properties​

commitMessage​

• Optional commitMessage: string

the commit message

Defined in​

src/commitAndSync.ts:11

commitOnly​

• Optional commitOnly: boolean

Defined in​

src/commitAndSync.ts:12

defaultGitInfo​

• Optional defaultGitInfo: Object

Optional fallback of userInfo. If some info is missing in userInfo, will use defaultGitInfo instead.

Type declaration​

NameType
branchstring
emailstring
gitUserNamestring
remotestring

Defined in​

src/commitAndSync.ts:14

dir​

• dir: string

wiki folder path, can be relative

Defined in​

src/commitAndSync.ts:16

filesToIgnore​

• Optional filesToIgnore: string[]

if you want to use a dynamic .gitignore, you can passing an array contains filepaths that want to ignore

Defined in​

src/commitAndSync.ts:18

logger​

• Optional logger: ILogger

Defined in​

src/commitAndSync.ts:19

remoteUrl​

• Optional remoteUrl: string

the storage service url we are sync to, for example your github repo url When empty, and commitOnly===true, it means we just want commit, without sync

Defined in​

src/commitAndSync.ts:23

userInfo​

• Optional userInfo: IGitUserInfos

user info used in the commit message When empty, and commitOnly===true, it means we just want commit, without sync

Defined in​

src/commitAndSync.ts:27