Class Firebase

Firebase backend.

Hierarchy (view full)

AuthBackend
- Firebase

Constructors

constructor

new Firebase(url, o?): Firebase
Parameters
- url: any
- o: {} = {}
Returns Firebase
Inherited from AuthBackend.constructor
- Defined in src/auth-backend.js:14

Properties

app

app: any

data

data: any

options

options: any

permissions

permissions: any

rawData

rawData: string

ready

ready: Promise<any> = ...

ref

ref: any

source

source: string

user

user: any

`Static` _all

_all: any[] = []

`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: {
path: string;
} = ...

Type declaration

path: string

`Static` hooks

hooks: Hooks = hooks

`Static` phrases

phrases: {
delete_collection_warning: string;
} = ...

Type declaration

delete_collection_warning: string

`Static` urls

urls: {
hostname: string;
}[] = ...

Type declaration

hostname: string

`Static` urlsKnown

urlsKnown: ({
    hostname?: undefined;
    pathname: string;
    protocol: string;
} | {
    hostname: string;
    pathname?: undefined;
    protocol: string;
})[] = ...

`Static` userCall

userCall: string = "user"

Accessors

`Static` all

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

`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 AuthBackend.authProviderServices
- Defined in src/backend.js:415

`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 AuthBackend.host
- Defined in src/backend.js:266

`Static` title

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

Methods

`Private` #applyDefaults

#applyDefaults(ref?): any
Parameters
- ref: any = ...
Returns any
- Defined in backends/firebase/index.js:272

`Private` #getFormat

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

_getRef

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

activeLogin

activeLogin(): Promise<void>
Abstract
Show authentication UI to the user. Must be implemented by subclasses.

Returns Promise<void>
Overrides AuthBackend.activeLogin
- Defined in backends/firebase/index.js:241

delete

delete(ref): Promise<any>
Parameters
- ref: any
Returns Promise<any>
- Defined in backends/firebase/index.js:146

deleteLocalUserInfo

deleteLocalUserInfo(): void
Abstract
Delete any info used to log users in passively.

Returns void
Overrides AuthBackend.deleteLocalUserInfo
- Defined in backends/firebase/index.js:267

equals

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

get

get(ref?): Promise<any>
Low-level method to fetch data from the backend. Subclasses should override this method. Clients should not call this method directly, but use load() instead.
Parameters
- ref: any = ...
  reference to data to fetch, if different from that provided in the constructor
Returns Promise<any>
- Data from the backend as a string, null if not found
Overrides AuthBackend.get
- Defined in backends/firebase/index.js:52

getUser

getUser(): Promise<any>
Get info about the current user, if logged in.

Returns Promise<any>
- User info
Overrides AuthBackend.getUser
- Defined in backends/firebase/index.js:204

isAuthenticated

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

Returns boolean
Inherited from AuthBackend.isAuthenticated
- Defined in src/auth-backend.js:29

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 AuthBackend.load
- Defined in src/backend.js:185

login

login(options): Promise<any>
Log a user in, either passively (without triggering any login UI) or actively (with login UI)
Parameters
- options: any
  {object}
Returns Promise<any>
Overrides AuthBackend.login
- Defined in backends/firebase/index.js:226

logout

logout(): Promise<void>
Returns Promise<void>
Overrides AuthBackend.logout
- Defined in backends/firebase/index.js:256

parse

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

passiveLogin

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

Returns Promise<void>
Overrides AuthBackend.passiveLogin
- Defined in backends/firebase/index.js:237

put

put(data, __namedParameters?): Promise<{
    id?: undefined;
    ids: any[];
} | {
    id: any;
    ids: undefined;
}>
Parameters
- data: any
- __namedParameters: {
  path: any;
  ref: any;
  } = {}
  - path: any
  - ref: any
Returns Promise<{
    id?: undefined;
    ids: any[];
} | {
    id: any;
    ids: undefined;
}>
- Defined in backends/firebase/index.js:89

remove

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

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 AuthBackend.store
- Defined in src/backend.js:223

storeLocalUserInfo

storeLocalUserInfo(o?): Promise<void>
Abstract
Store info that can be used to log users in passively.
Parameters
- o: {} = {}
Returns Promise<void>
Inherited from AuthBackend.storeLocalUserInfo
- Defined in src/auth-backend.js:161

stringify

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

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 AuthBackend.syncWith
- Defined in src/auth-backend.js:179

toString

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

update

update(source, o?): void
Update an existing backend instance with new parameters
Parameters
- source: string
  Same as constructor
- o: any = {}
  Same as constructor
Returns void
Inherited from AuthBackend.update
- Defined in src/backend.js:40

updatePermissions

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

upload

upload(file, path): Promise<any>
Parameters
- file: any
- path: any
Returns Promise<any>
- Defined in backends/firebase/index.js:184

`Static` `Private` #isCollection

#isCollection(ref): boolean
Parameters
- ref: any
Returns boolean
- Defined in backends/firebase/index.js:280

`Static` find

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

`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 AuthBackend.from
- Defined in src/backend.js:305

`Static` load

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

`Static` parseURL

parseURL(source): any
Parse URL.
Parameters
- source: string
  Database URL | URL of a file in Firebase Storage.
Returns any
Project ID, auth domain, storage bucket | A flag whether a file is in Firebase Storage, file URL.
Overrides AuthBackend.parseURL
- Defined in backends/firebase/index.js:306

`Static` phrase

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

`Static` register

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

`Static` test

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

Class Firebase

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

url: any

o: {} = {}

Returns Firebase

Properties

app

data

options

permissions

rawData

ready

ref

source

user

Static _all

Static authProvider

Static capabilities

Type declaration

auth: boolean

put: boolean

upload: boolean

Static defaultFormat

Static defaultPermissions

Type declaration

read: boolean

Static defaults

Type declaration

path: string

Static hooks

Static phrases

Type declaration

delete_collection_warning: string

Static urls

Type declaration

hostname: string

Static urlsKnown

Static userCall

Accessors

Static all

Returns any[]

Static authProviderServices

Returns Promise<any>

Member

Static host

Returns any

Static title

Returns string

Methods

Private #applyDefaults

Parameters

ref: any = ...

Returns any

Private #getFormat

Parameters

ref: any

Returns any

_getRef

Parameters

ref: any

Returns any

activeLogin

Returns Promise<void>

delete

Parameters

ref: any

Returns Promise<any>

deleteLocalUserInfo

Returns void

equals

Parameters

backend: any

`Static` _all

`Static` authProvider

`Static` capabilities

`Static` defaultFormat

`Static` defaultPermissions

`Static` defaults

`Static` hooks

`Static` phrases

`Static` urls

`Static` urlsKnown

`Static` userCall

`Static` all

`Static` authProviderServices

`Static` host

`Static` title

`Private` #applyDefaults

`Private` #getFormat

`Rest` ...args: any[]

__namedParameters: {
ref: any;
} = {}

__namedParameters: {
path: any;
ref: any;
} = {}

Returns Promise<{
id?: undefined;
ids: any[];
} | {
id: any;
ids: undefined;
}>

`Optional` o: any = {}

__namedParameters: {
ref: any;
} = {}