Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GitHubLazyProject

Lazy project that loads remote GitHub project and forwards to it only if necessary.

Hierarchy

  • AbstractProject
    • GitHubLazyProject

Implements

  • ScriptedFlushable<Project>
  • Project
  • GitProject
  • LazyProject

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

branch

branch: string = this.id.branch

Readonly cache

cache: Record<string, object>

Private Readonly delegate

delegate: ProjectLoader

id

id: RepoRef

newRepo

newRepo: boolean = false

Private Readonly params

params: ProjectLoadingParameters

Private projectPromise

projectPromise: QueryablePromise<GitProject>

remote

remote: string = (this.id as RemoteRepoRef).url

shouldCache

shouldCache: boolean

Accessors

baseDir

  • get baseDir(): string

dirty

  • get dirty(): boolean

  • Returns boolean

name

  • get name(): string

  • Returns string

provenance

  • get provenance(): string

Methods

add

  • Parameters

    • f: File

    Returns Promise<this>

addDirectory

  • addDirectory(path: string): Promise<this>

addFile

  • addFile(path: string, content: string): Promise<this>

addFileSync

  • addFileSync(path: string, content: string): void

checkout

  • checkout(sha: string): Promise<this>

commit

  • commit(message: string): Promise<this>

configureFromRemote

  • configureFromRemote(): Promise<this>

createAndSetRemote

  • createAndSetRemote(gid: RemoteRepoRef, description: string, visibility: "private" | "public"): Promise<this>

createBranch

  • createBranch(name: string): Promise<this>

deleteDirectory

  • deleteDirectory(path: string): Promise<this>

deleteDirectorySync

  • deleteDirectorySync(path: string): void

deleteFile

  • deleteFile(path: string): Promise<this>

deleteFileSync

  • deleteFileSync(path: string): void

directoryExistsSync

  • directoryExistsSync(path: string): boolean

fileExistsSync

  • fileExistsSync(path: string): boolean

findFile

  • findFile(path: string): Promise<File>

findFileSync

  • findFileSync(path: string): File

flush

  • Returns Promise<this>

getFile

  • getFile(path: string): Promise<File | undefined>

getFiles

  • getFiles(globPatterns?: string | string[]): Promise<File[]>

  • Get files matching these patterns

    Parameters

    • Optional globPatterns: string | string[]

    Returns Promise<File[]>

Protected getFilesInternal

  • getFilesInternal(globPatterns: string[]): Promise<File[]>

gitStatus

hasBranch

  • hasBranch(name: string): Promise<boolean>

hasDirectory

  • hasDirectory(path: string): Promise<boolean>

hasFile

  • hasFile(path: string): Promise<boolean>

  • Parameters

    • path: string

    Returns Promise<boolean>

init

Protected invalidateCache

  • invalidateCache(): void

isClean

makeExecutable

  • makeExecutable(path: string): Promise<this>

makeExecutableSync

  • makeExecutableSync(path: string): void

materialize

  • materialize(): Promise<GitProject>

Private materializeIfNecessary

materialized

  • materialized(): boolean

materializing

  • materializing(): boolean

moveFile

  • moveFile(oldPath: string, newPath: string): Promise<this>

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<this>

push

  • push(options?: GitPushOptions): Promise<this>

raisePullRequest

  • raisePullRequest(title: string, body: string, targetBranch?: string): Promise<this>

recordAction

  • recordAction(action: ScriptAction<Project, any>): this

  • Parameters

    • action: ScriptAction<Project, any>

    Returns this

recordAddFile

  • recordAddFile(path: string, content: string): this

  • Parameters

    • path: string
    • content: string

    Returns this

recordDeleteFile

  • recordDeleteFile(path: string): this

  • Parameters

    • path: string

    Returns this

release

revert

setRemote

  • setRemote(remote: string): Promise<this>

setUserConfig

  • setUserConfig(user: string, email: string): Promise<this>

streamFiles

  • streamFiles(...globPatterns: string[]): FileStream

  • Parameters

    • Rest ...globPatterns: string[]

    Returns FileStream

streamFilesRaw

  • streamFilesRaw(globPatterns: string[], opts: {}): FileStream

totalFileCount

  • totalFileCount(): Promise<number>

trackFile

  • trackFile(f: FileNonBlocking): this

  • Parameters

    • f: FileNonBlocking

    Returns this

Generated using TypeDoc