ActiveClass Methods

All ActiveDocuments - that is, all instances of ES6 classes that extend ActiveClass - come with some default methods, used for interacting with your Firebase Realtime Database.

import { ActiveClass, Schema } from 'fireactive'

const schema = {

name: Schema.string,

age: Schema.number

}

// Person is an ActiveClass

class Person extends ActiveClass(schema) {}

// ariana is an ActiveDocument

const ariana = new Person({ name: 'Ariana', age: 24 })

typeof ariana.name // => 'string'

typeof ariana.age // => 'number'

typeof ariana.save // => 'function'

typeof ariana.toObject // => 'function'

Have you initialized?

To interact with your Firebase Realtime Database, you must first initialize a connection to your Firebase Realtime Database.

import { initialize } from 'fireactive'

import { Person } from './models/Person'

const ariana = new Person({ name: 'Ariana', age: 24 })

await ariana.save()

/*

* ActiveClassError: Failed to save Person into database.

* Could not connect to your Firebase database.

* This might be because you have not initialized your Firebase app.

* Try calling Fireactive.initialize

*/

initialize({

databaseURL: 'https://your-database.firebase.io'

})

await ariana.save() // runs

getId

Returns the ActiveDocument's _id property, or generates one if it does not already have one.

Parameters: None

Returns: string, or throws an error if it tries to generate an _id but the Firebase Realtime Database is not initialized

Example

• JavaScript
• TypeScript

const ariana = new Person({ name: 'Ariana', age: 24 })

ariana._id // => undefined

ariana.getId() // => '-M6L2H0...'

ariana._id // => '-M6L2H0...'

const taylor = await Person.create({ name: 'Taylor', age: 29 })

taylor._id // => '-M7K4IP...'

taylor.getId() // => '-M7K4IP...'

reload

Refreshes the ActiveDocument's properties based on the current database values.

Parameters: None

Returns: Promise<object>, a promise that resolves into the object reloaded from the database

Example

• JavaScript
• TypeScript

// create document in db

const ariana = await Person.create({ name: 'Ariana', age: 24 })

// turn off automatic syncing from db

ariana.syncOpts({ fromDb: false })

// write to db using Firebase api

await ariana.ref().update({ age: 25 })

ariana.age // => 24

await ariana.reload() // => { name: 'Ariana', age: 25 }

ariana.age // => 25

ref

Return the Firebase database Reference for the ActiveDocument or a specified child path.

Parameters:

• path : string (optional), the path to locate the reference for starting from the root of the ActiveDocument

Returns: a firebase.database.Reference for the ActiveDocument or a specified child path

const ariana = await Person.create({ name: "Ariana", age: 24 })

ariana.ref().toString()

// => 'https://your-database.firebase.io/People/-M86Z9...'

ariana.ref('age').toString()

// => 'https://your-database.firebase.io/People/-M86Z9.../age'

save

Saves an ActiveDocument and its current properties to the database

const ariana = new Person({ name: "Ariana", age: 24 })

ariana.age = 25

await ariana.save()

const dbSnapshot = await ariana.ref().once('value')

dbSnapshot.val().name // => 'Ariana'

dbSnapshot.val().age // => 25

pendingSetters

Returns a promise that resolves when all setter promises have resolved to the database.

const ariana = await Person.create({ name: 'Ariana', age: 24 })

ariana.pendingSetters({ count: true }) // => 0

ariana.age = 25

ariana.age // => 25

ariana.name = 'Ms Grande'

ariana.age // => 'Ms Grande'

// there are now two pending setters

ariana.pendingSetters({ count: true }) // => 2

// wait for them to resolve

await ariana.pendingSetters()

// there will be no more pending setters left

ariana.pendingSetters({ count: true }) // => 0

// db will now have correct values

const snapshot = await ariana.ref().once('value')

snapshot.val().name // => 'Ms Grande'

snapshot.val().age // => 25

syncOpts

Returns (and optionally updates) the current sync settings for the ActiveDocument

Parameters:

• opts : { toDb?: boolean, fromDb?: boolean }, optional
  • opts.toDb : boolean, should changes to the document's properties automatically sync to the database automatically (without calling .save)?
  • opts.fromDb : boolean, should changes from the database automatically sync to the document (without calling reload)?

Returns: { fromDb: boolean, toDb: boolean }, an object representing the current sync settings for the ActiveDocument

Default settings

create

Active Documents created via the create method have toDb and fromDb syncing on by default.

• toDb: true means that, when you set a property on the ActiveDocument, it automatically syncs to the Firebase Realtime Database;
• fromDb: true means that, when the Firebase Realtime Database is updated, it automatically syncs back to the ActiveDocument

let ariana = await Person.create({ name: 'Ariana', age: 24 })

ariana.syncOpts() // => { fromDb: true, toDb: true }

// so changes sync TO database

ariana.age = 25

// await the promise with the update for the database

await ariana.pendingSetters()

const snapshot = await ariana.ref().once('value')

snapshot.val().age // => 25

// (has synced to db)

// and changes sync FROM database

await ariana.ref().update({ name: "Ms Grande" })

ariana.name // => "Ms Grande"

// (has synced from db)

new

Active Documents created via the new constructor have toDb and fromDb syncing off by default.

• toDb: false means that, when you set a property on the ActiveDocument, it doesn't automatically sync to the Firebase Realtime Database;
• fromDb: false means that, when the Firebase Realtime Database is updated, it doesn't automatically sync back to the ActiveDocument

let ariana = new Person({ name: 'Ariana', age: 24 })

// save to database

ariana.syncOpts() // => { fromDb: false, toDb: false }

await ariana.save()

// so changes don't sync TO database

ariana.age = 25

const snapshot = await ariana.ref().once('value')

snapshot.val().age // => 24

// (hasn't synced to db)

// and changes don't sync FROM database

await ariana.ref().update({ name: "Ms Grande" })

ariana.name // => "Ariana"

// (hasn't synced from db)

Updating settings

You can update the sync options for a given ActiveDocument by passing in an object of new settings.

For example, suppose we wanted to turn off automatic syncing from the database for an ActiveDocument instantiated using create (which has syncing on by default)"

// create document in db

const ariana = await Person.create({ name: 'Ariana', age: 24 })

// syncing from database is on by default with `create`

ariana.syncOpts()

// => { fromDb: true, toDb: true }

// turn off automatic syncing from db

ariana.syncOpts({ fromDb: false })

// => { fromDb: false, toDb: true }

// write to db using Firebase api

await ariana.ref().update({ age: 25 })

ariana.age // => 24 (syncing is off)

// manually sync from db using reload

await ariana.reload()

// => { _id: '-M6L56...' name: 'Ariana', age: 25 }

ariana.age // => 25