BaseSource Class
Classes
Section titled “Classes”abstract BaseSource
Section titled “abstract BaseSource”Defined in: sources/base.source.ts:5
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseSource(config): BaseSource;Defined in: sources/base.source.ts:8
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
config | Static |
Returns
Section titled “Returns”Properties
Section titled “Properties”| Property | Type | Defined in |
|---|---|---|
baseBranch | string | sources/base.source.ts:6 |
Methods
Section titled “Methods”checkout()
Section titled “checkout()”checkout(branch): void;Defined in: sources/base.source.ts:12
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
branch | string |
Returns
Section titled “Returns”void
commitFile()
Section titled “commitFile()”commitFile(__namedParameters): void;Defined in: sources/base.source.ts:40
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
__namedParameters | { message: string; path: string; } |
__namedParameters.message | string |
__namedParameters.path | string |
Returns
Section titled “Returns”void
ensurePullRequest()
Section titled “ensurePullRequest()”abstract ensurePullRequest(__namedParameters): Promise<void>;Defined in: sources/base.source.ts:55
Ensures a pull request exists Creates the pull request if it doesn’t exist or updates it if it does
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
__namedParameters | { branch: string; description: string; title: string; } |
__namedParameters.branch | string |
__namedParameters.description | string |
__namedParameters.title | string |
Returns
Section titled “Returns”Promise<void>
push()
Section titled “push()”push(branch): void;Defined in: sources/base.source.ts:46
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
branch | string |
Returns
Section titled “Returns”void