git-sync-js / initGit / IInitGitOptionsSyncImmediately

Interface: IInitGitOptionsSyncImmediately

initGit.IInitGitOptionsSyncImmediately

Table of contents

Properties

• defaultGitInfo
• dir
• logger
• remoteUrl
• syncImmediately
• userInfo

Properties

defaultGitInfo

• Optional defaultGitInfo: Object

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

Type declaration

Name	Type
branch	string
email	string
gitUserName	string
remote	string

Defined in

src/initGit.ts:12

---

dir

• dir: string

wiki folder path, can be relative

Defined in

src/initGit.ts:14

---

logger

• Optional logger: ILogger

Defined in

src/initGit.ts:15

---

remoteUrl

• remoteUrl: string

only required if syncImmediately is true, the storage service url we are sync to, for example your github repo url

Defined in

src/initGit.ts:17

---

syncImmediately

• syncImmediately: true

should we sync after git init?

Defined in

src/initGit.ts:19

---

userInfo

• userInfo: IGitUserInfos

user info used in the commit message

Defined in

src/initGit.ts:21