git-sync-js / credential

Module: credential

Table of contents

Enumerations

• ServiceType

Functions

• credentialOff
• credentialOn
• getGitHubUrlWithCredential

Functions

credentialOff

▸ credentialOff(directory, remoteName, remoteUrl?, serviceType?): Promise<void>

Add remote without credential

Parameters

Name	Type	Default value
directory	string	undefined
remoteName	string	undefined
remoteUrl?	string	undefined
serviceType	Github	ServiceType.Github

Returns

Promise<void>

Defined in

src/credential.ts:44

---

credentialOn

▸ credentialOn(directory, remoteUrl, userName, accessToken, remoteName, serviceType?): Promise<void>

Add remote with credential

Parameters

Name	Type	Default value
directory	string	undefined
remoteUrl	string	undefined
userName	string	undefined
accessToken	string	undefined
remoteName	string	undefined
serviceType	Github	ServiceType.Github

Returns

Promise<void>

Defined in

src/credential.ts:20

---

getGitHubUrlWithCredential

▸ getGitHubUrlWithCredential(rawUrl, username, accessToken): string

Parameters

Name	Type
rawUrl	string
username	string
accessToken	string

Returns

string

Defined in

src/credential.ts:10