Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractRemoteRepoRef

Superclass for RemoteRepoRef implementations. Handles parsing remote base

This should ultimately move down to automation-client-ts and replace AbstractRepoRef.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

  • new AbstractRemoteRepoRef(providerType: ProviderType, rawRemote: string, rawApiBase: string, owner: string, repo: string, sha: string, path?: string, branch?: string): AbstractRemoteRepoRef

  • Construct a new RemoteRepoRef

    Parameters

    • providerType: ProviderType
    • rawRemote: string

      remote url, like for cloning or linking into the repo. Should start with a scheme. May have a trailing slash, which will be stripped

    • rawApiBase: string

      API base url. Should start with a scheme. May have a trailing slash, which will be stripped.

    • owner: string
    • repo: string
    • sha: string
    • Optional path: string
    • Optional branch: string

    Returns AbstractRemoteRepoRef

Properties

Readonly apiBase

apiBase: string

API URL without the scheme or trailing '/'.

Optional branch

branch: string

Readonly Abstract kind

kind: string

Readonly owner

owner: string

Optional Readonly path

path: string

Readonly providerType

providerType: ProviderType

Readonly remoteBase

remoteBase: string

Git remote URL not including scheme or trailing '/'

Readonly repo

repo: string

Readonly scheme

scheme: "http://" | "https://"

URL scheme from applied to both API and remote bases.

Readonly sha

sha: string

Accessors

pathComponent

  • get pathComponent(): string

url

  • get url(): string

Methods

cloneUrl

Abstract createRemote

Abstract deleteRemote

Abstract raisePullRequest

Abstract setUserConfig

Generated using TypeDoc