git-sync-js / clone

Module: clone

Table of contents

Functions

• clone

Functions

clone

▸ clone(options): Promise<void>

Parameters

Name	Type	Default value	Description
options	Object	undefined	-
options.defaultGitInfo?	Object	undefined	Optional fallback of userInfo. If some info is missing in userInfo, will use defaultGitInfo instead.
options.defaultGitInfo.branch	string	'main'	-
options.defaultGitInfo.email	string	'gitsync@gmail.com'	-
options.defaultGitInfo.gitUserName	string	'gitsync'	-
options.defaultGitInfo.remote	string	'origin'	-
options.dir	string	undefined	wiki folder path, can be relative, should exist before function call
options.logger?	ILogger	undefined	-
options.remoteUrl?	string	undefined	the storage service url we are sync to, for example your github repo url
options.userInfo?	IGitUserInfos	undefined	user info used in the commit message

Returns

Promise<void>

Defined in

src/clone.ts:10