Class GithubFile

Backend for reading and writing data and uploading files in GitHub repositories.

Hierarchy (view full)

Github
- GithubFile

Constructors

constructor

new GithubFile(url, o?): GithubFile
Parameters
- url: string
  URL string describing the data location
- o: any = {}
  Options
Returns GithubFile
Inherited from Github.constructor
- Defined in src/oauth-backend.js:16

Properties

accessToken

accessToken: any

apiKey

apiKey: any

authPopup

authPopup: Window

clientId

clientId: any

data

data: any

options

options: any

permissions

permissions: any

rawData

rawData: string

ready

ready: Promise<void>

ref

ref: any

source

source: string

user

user: any

`Static` _all

_all: any[] = []

`Static` api

api: {
    get: ((ref) => string);
    put: ((ref) => string);
    user: {
        fields: {
            avatar: string;
            name: string[];
            url: (() => string);
            username: string;
        };
        get: string;
    };
} = ...

Type declaration

get: ((ref) => string)
- - (ref): string
  - Parameters
    - ref: any
    Returns string
put: ((ref) => string)
- - (ref): string
  - Parameters
    - ref: any
    Returns string
user: {
    fields: {
        avatar: string;
        name: string[];
        url: (() => string);
        username: string;
    };
    get: string;
}
- fields: {
      avatar: string;
      name: string[];
      url: (() => string);
      username: string;
  }
  - avatar: string
  - name: string[]
  - url: (() => string)
    - - (): string
      - Returns string
  - username: string
- get: string

`Static` apiDomain

apiDomain: string = "https://api.github.com/"

`Static` authProvider

authProvider: string = "https://auth.madata.dev"

Auth Provider to use. This is only relevant for OAuthBackend, but specifying here as Backend is the only class users import.

`Static` capabilities

capabilities: {
    auth: boolean;
    put: boolean;
    upload: boolean;
} = ...

Type declaration

auth: boolean
put: boolean
upload: boolean

`Static` defaultFormat

defaultFormat: string = "JSON"

`Static` defaultPermissions

defaultPermissions: {
read: boolean;
} = ...

Type declaration

read: boolean

`Static` defaults

defaults: {
    branch: any;
    owner: any;
    path: string;
    repo: string;
} = ...

Type declaration

branch: any
owner: any
path: string
repo: string

`Static` fileBased

fileBased: boolean = true

`Static` hooks

hooks: Hooks = hooks

`Static` oAuth

oAuth: string = "https://github.com/login/oauth/authorize"

`Static` phrases

phrases: {
no_write_permission: ((ref) => string);
} = ...

Type declaration

no_write_permission: ((ref) => string)
- - (ref): string
  - Parameters
    - ref: any
    Returns string

`Static` urls

urls: string[] = ...

Accessors

`Static` all

get all(): any[]
Returns any[]
Inherited from Github.all
- Defined in src/backend.js:439

`Static` authProviderServices

get authProviderServices(): Promise<any>
services.json from the auth provider will be cached here. You could also set this manually to avoid the network request.

Returns Promise<any>
Member
Inherited from Github.authProviderServices
- Defined in src/backend.js:498

`Static` host

get host(): any
Return the hostname of the first URL pattern in the urls array, if not variable. This is used to facilitate relative URLs when constructing Backends directly. Subclasses with variable hostnames can override this.

Returns any
Inherited from Github.host
- Defined in src/backend.js:354

`Static` oAuthParams

get oAuthParams(): string
Returns string
Inherited from Github.oAuthParams
- Defined in backends/github/github.js:11

`Static` title

get title(): string
Returns string
Inherited from Github.title
- Defined in src/backend.js:44

`Static` tokenKey

get tokenKey(): string
Returns string
Inherited from Github.tokenKey
- Defined in src/oauth-backend.js:256

Methods

`Private` #getFormat

#getFormat(ref): any
Parameters
- ref: any
Returns any
Inherited from Github.#getFormat
- Defined in src/backend.js:102

`Private` #write

#write(type, ref, ...args): Promise<any>
Parameters
- type: any
- ref: any
- Rest ...args: any[]
Returns Promise<any>
- Defined in backends/github/file/github-file.js:128

_getRef

_getRef(ref): any
Parameters
- ref: any
Returns any
Inherited from Github._getRef
- Defined in src/backend.js:236

activeLogin

activeLogin(o): Promise<any>
Abstract
Show authentication UI to the user. Must be implemented by subclasses.
Parameters
- o: any
Returns Promise<any>
Inherited from Github.activeLogin
- Defined in src/oauth-backend.js:170

canPush

canPush(ref?): Promise<any>
Parameters
- ref: any = ...
Returns Promise<any>
- Defined in backends/github/file/github-file.js:224

createRepo

createRepo(ref, options?): Promise<any>
Parameters
- ref: any
- options: {} = {}
Returns Promise<any>
- Defined in backends/github/file/github-file.js:239

delete

delete(ref?): Promise<any>
Parameters
- ref: any = ...
Returns Promise<any>
- Defined in backends/github/file/github-file.js:124

deleteLocalUserInfo

deleteLocalUserInfo(): void
Delete access token from local storage

Returns void
Inherited from Github.deleteLocalUserInfo
- Defined in src/oauth-backend.js:250

equals

equals(backend): boolean
Parameters
- backend: any
Returns boolean
Inherited from Github.equals
- Defined in src/backend.js:341

fetchRepoInfo

fetchRepoInfo(ref?): Promise<any>
Parameters
- ref: any = ...
Returns Promise<any>
- Defined in backends/github/file/github-file.js:254

fork

fork(ref?, options?): Promise<any>
Fork a repo, or return a fork if one already exists
Parameters
- Optional ref: any = ...
- Optional options: options = {}
Returns Promise<any>
- Defined in backends/github/file/github-file.js:335

get

get(ref?): string
Low-level method to fetch a file from GitHub
Parameters
- ref: any = ...
Returns string
File contents as a string, or null if not found
Overrides Github.get
- Defined in backends/github/file/github-file.js:40

getFileURL

getFileURL(path?, __namedParameters?): Promise<any>
Get a public URL for a file in a repo
Parameters
- path: any = ...
- __namedParameters: {
  ref: any;
  } = {}
  - ref: any
Returns Promise<any>
- Defined in backends/github/file/github-file.js:421

getMyFork

getMyFork(repoInfo?): any
Find forks of a repo by the current user
Parameters
- repoInfo: any = ...
Returns any
repoInfo object about the fork or null
- Defined in backends/github/file/github-file.js:284

getPagesInfo

getPagesInfo(ref?): Promise<any>
Parameters
- ref: any = ...
Returns Promise<any>
- Defined in backends/github/file/github-file.js:386

getRepoURL

getRepoURL(ref?, __namedParameters?): Promise<any>
Parameters
- ref: any = ...
- __namedParameters: {
  sha: any;
  } = {}
  - sha: any
Returns Promise<any>
- Defined in backends/github/file/github-file.js:399

getUser

getUser(): Promise<any>
Get info about the current user, if logged in. Subclasses are generally expected to override this.

Returns Promise<any>
- User info
Inherited from Github.getUser
- Defined in src/auth-backend.js:43

getUserIfValid

getUserIfValid(): Promise<any>
Returns Promise<any>
Inherited from Github.getUserIfValid
- Defined in src/oauth-backend.js:148

isAuthenticated

isAuthenticated(): boolean
Is current user authenticated? Synchronous because it must not trigger any API calls, use passiveLogin() for that

Returns boolean
Inherited from Github.isAuthenticated
- Defined in src/oauth-backend.js:54

load

load(url, ...args): any
Higher-level method for reading data from the backend. Subclasses should usually NOT override this method.
Parameters
- url: string
  URL to fetch, if different from that provided in the constructor
- Rest ...args: any[]
Returns any
- Data from the backend as a JSON object, null if not found
Inherited from Github.load
- Defined in src/backend.js:259

login

login(...args): Promise<any>
Helper method for authenticating in OAuth APIs
Parameters
- Rest ...args: any[]
  {object}
Returns Promise<any>
Overrides Github.login
- Defined in backends/github/file/github-file.js:196

logout

logout(): Promise<void>
oAuth logout helper

Returns Promise<void>
Inherited from Github.logout
- Defined in src/oauth-backend.js:224

parse

parse(data, __namedParameters?): Promise<any>
Parameters
- data: any
- __namedParameters: {
  ref: any;
  } = {}
  - ref: any
Returns Promise<any>
Inherited from Github.parse
- Defined in src/backend.js:74

passiveLogin

passiveLogin(): Promise<void>
Abstract
Try to authenticate a previously authenticated user (i.e. without showing any login UI).

Returns Promise<void>
Inherited from Github.passiveLogin
- Defined in src/oauth-backend.js:217

publish

publish(ref?, __namedParameters?): Promise<any>
Parameters
- ref: any = ...
- __namedParameters: {
  https_enforced: boolean;
  } = {}
  - https_enforced: boolean
Returns Promise<any>
- Defined in backends/github/file/github-file.js:364

put

put(data, path?): Promise<any>
Saves a file to the backend.
Parameters
- data: any
- path: string = {}
  Optional file path
Returns Promise<any>
A promise that resolves when the file is saved.
Overrides Github.put
- Defined in backends/github/file/github-file.js:109

remove

remove(ref?): Promise<any>
Parameters
- ref: any = ...
Returns Promise<any>
Inherited from Github.remove
- Defined in src/backend.js:325

request

request(call, data?, method?, req?): Promise<any>
Helper for making OAuth requests with JSON-based APIs.
Parameters
- call: string
  API endpoint
- Optional data: any
  Data to send with the request
- Optional method: string = "GET"
  HTTP method
- Optional req: {
  headers: any;
  responseType: string;
  }
  Extra request options
  - headers: any
    Extra headers
  - responseType: string
    Response type
Returns Promise<any>
- JSON response
Inherited from Github.request
- Defined in src/oauth-backend.js:73

store

store(data, o?): any
Higher-level method for writing data to the backend. Subclasses should usually NOT override this method.
Parameters
- data: any
  Data to write to the backend
- Optional o: any = {}
  Options object
Returns any
- If successful, info about the stored data
Inherited from Github.store
- Defined in src/backend.js:311

storeLocalUserInfo

storeLocalUserInfo(param0): Promise<void>
Store access token in local storage
Parameters
- param0: any
Returns Promise<void>
Inherited from Github.storeLocalUserInfo
- Defined in src/oauth-backend.js:243

stringify

stringify(data, __namedParameters?): Promise<any>
Parameters
- data: any
- __namedParameters: {
  ref: any;
  } = {}
  - ref: any
Returns Promise<any>
Inherited from Github.stringify
- Defined in src/backend.js:88

syncWith

syncWith(backend): void
Sync the logged in user, i.e. log in passively when another backend has logged in and log out when another backend has logged out. Generally intended to be used for backends with the same authentication mechanism. Syncing is not two-way, you need to call this on the other backend as well to make it so.
Parameters
- backend: AuthBackend
Returns void
Inherited from Github.syncWith
- Defined in src/auth-backend.js:183

toString

toString(): string
Returns string
Inherited from Github.toString
- Defined in src/backend.js:337

update

update(url, o): void
Update an existing backend instance with new parameters
Parameters
- url: string
  Same as constructor
- o: any
  Same as constructor
Returns void
Inherited from Github.update
- Defined in src/oauth-backend.js:39

updatePermissions

updatePermissions(o): void
Parameters
- o: any
Returns void
Inherited from Github.updatePermissions
- Defined in src/backend.js:132

upload

upload(file, __namedParameters?): Promise<any>
Parameters
- file: any
- __namedParameters: {
  path: any;
  } = {}
  - path: any
Returns Promise<any>
Overrides Github.upload
- Defined in backends/github/file/github-file.js:114

`Static` find

find(url, o): any
Parameters
- url: any
- o: any
Returns any
Inherited from Github.find
- Defined in src/backend.js:447

`Static` from

from(url, o?): any
Return the appropriate backend(s) for this url
Parameters
- url: string
  URL describing the storage location
- Optional o: {
  existing: Backend | Backend[];
  } = {}
  Options object to be passed to the backend
  - existing: Backend | Backend[]
    Existing backend object(s) to re-use if possible
Returns any
Inherited from Github.from
- Defined in src/backend.js:393

`Static` getOAuthBackend

getOAuthBackend(): any
Returns any
Inherited from Github.getOAuthBackend
- Defined in src/oauth-backend.js:84

`Static` load

load(url, o): Promise<any>
Parameters
- url: any
- o: any
Returns Promise<any>
Inherited from Github.load
- Defined in src/backend.js:427

`Static` parseURL

parseURL(source): any
Parameters
- source: any
Returns any
Inherited from Github.parseURL
- Defined in src/backend.js:372

`Static` phrase

phrase(id, ...args): string
Parameters
- id: any
- Rest ...args: any[]
Returns string
Inherited from Github.phrase
- Defined in src/backend.js:483

`Static` register

register(Class): any
Parameters
- Class: any
Returns any
Inherited from Github.register
- Defined in src/backend.js:463

`Static` sameRepo

sameRepo(file1, file2): boolean
Parameters
- file1: any
- file2: any
Returns boolean
- Defined in backends/github/file/github-file.js:95

`Static` test

test(source): boolean
Parameters
- source: any
Returns boolean
Inherited from Github.test
- Defined in src/backend.js:345

Class GithubFile

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

url: string

o: any = {}

Returns GithubFile

Properties

accessToken

apiKey

authPopup

clientId

data

options

permissions

rawData

ready

ref

source

user

Static _all

Static api

Type declaration

get: ((ref) => string)

Parameters

ref: any

Returns string

put: ((ref) => string)

Parameters

ref: any

Returns string

user: { fields: { avatar: string; name: string[]; url: (() => string); username: string; }; get: string; }

fields: { avatar: string; name: string[]; url: (() => string); username: string; }

avatar: string

name: string[]

url: (() => string)

Returns string

username: string

get: string

Static apiDomain

Static authProvider

Static capabilities

Type declaration

auth: boolean

put: boolean

upload: boolean

Static defaultFormat

Static defaultPermissions

Type declaration

read: boolean

Static defaults

Type declaration

branch: any

owner: any

path: string

repo: string

Static fileBased

Static hooks

Static oAuth

Static phrases

Type declaration

no_write_permission: ((ref) => string)

Parameters

ref: any

Returns string

Static urls

Accessors

Static all

Returns any[]

Static authProviderServices

Returns Promise<any>

Member

Static host

Returns any

`Static` _all

`Static` api

user: {
fields: {
avatar: string;
name: string[];
url: (() => string);
username: string;
};
get: string;
}

fields: {
avatar: string;
name: string[];
url: (() => string);
username: string;
}

`Static` apiDomain

`Static` authProvider

`Static` capabilities

`Static` defaultFormat

`Static` defaultPermissions

`Static` defaults

`Static` fileBased

`Static` hooks

`Static` oAuth

`Static` phrases

`Static` urls

`Static` all

`Static` authProviderServices

`Static` host

`Static` oAuthParams

`Static` title

`Static` tokenKey

`Private` #getFormat

`Private` #write

`Rest` ...args: any[]

`Optional` ref: any = ...

`Optional` options: options = {}

__namedParameters: {
ref: any;
} = {}