Record Factory

client.record gives you access to all methods related to data-sync.

Prerequisite

You need to connect to the deepstream server:

const { DeepstreamClient } = require('@deepstream/client')
const client = deepstream( 'localhost:6020')
client.login()

Methods

client.record.getRecord(name)

Retrieves and if necessary creates a Record with the given name. Records are persistent data structures that are synced between clients. To learn more about what they are used for and how they work, head over to the record tutorial.

const record = client.record.getRecord('user/johndoe')

client.record.getList(name)

Retrieves or creates a List with the given name. Lists are arrays of recordNames that clients can manipulate and observe. You can learn more about them in the list tutorial.

const beatlesAlbums = client.record.getList('albums')
beatlesAlbums.whenReady(() => {
  console.log(beatlesAlbums.getEntries())
})
/*
  [
    "album/i9l0z34v-109vblpqddy",
    "album/i9l0z3v4-ibrbp139rbr",
    "album/i9l0z4d8-1w0p8xnk1sy"
  ]
*/

client.record.getAnonymousRecord()

Returns an AnonymousRecord.

An AnonymousRecord is a record that can change its name. It acts as a wrapper around an actual record that can be swapped out for another one whilst keeping all bindings intact. You can learn more about anonymous records here.

const record = client.record.getAnonymousRecord()
record.setName('user/johndoe')
record.setName('user/maxpower')

client.record.has(name, callback)

The callback contains an error argument and a boolean to indicate whether or not the record exists in deepstream. This is useful to avoid creating a record via getRecord( name ) if you only want to edit the contents. The callback is invoked immediately if the record exists on the client.

// Callback
client.record.has('user/johndoe', (error, hasRecord) => {
  // ...
})

// Promise
try {
  const hasRecord = await client.record.has('user/johndoe')
  // ...
} catch (error) {

}

client.record.head(name, callback)

The callback contains an error argument and a number to indicate the current record version in deepstream.

// Callback
client.record.head('user/johndoe', (error, version) => {
  // ...
})

// Promise
try {
  const recordVersion = await client.record.head('user/johndoe')
  // ...
} catch (error) {

}

client.record.snapshot(name, callback)

The callback contains the record’s content without subscribing to updates. This can be used to avoid scenarios where you would request the record and discard it immediately afterwards. The callback is invoked immediately if the record data is already loaded and ready.

// Callback
client.record.snapshot('user/johndoe', (error, data) => {
	// ...
})

// Promise
try {
  const data = await client.record.snapshot('user/johndoe')
} catch (error) {

}

client.record.setData(name, path, data, callback)

An upsert operation that allows updating of a record without being subscribed to it. If the record does not exist deepstream will try and permission the request to create the record. The callback if provided will be called with any errors that occurred while writing to the record.

// Set the entire record's data - record will be created if it doesn't exist
client.record.setData('user/homer', { status: 'married' })

// Update only marriage status
record.set('user/homer', 'status', 'single')

// Set the entire record's data with write acknowledgement
client.record.setData('user/homer', { status: 'married' }, (error) => {
  // ...
})

// Update only a property with write acknowledgement
client.record.setData('user/homer', 'son', 'Bart', (err) => {
  // ...
})

client.record.listen(pattern, callback)

Allows to listen for record subscriptions made by other clients. This is useful to create “active” data providers, e.g. providers that only provide data for records that users are actually interested in. You can find more about listening in the record tutorial.

The callback is invoked with three arguments:

• match: The name of the record that has been matched against the provided pattern
• response: contains two functions (accept and reject), one of them needs to be called

client.record.listen('raceHorse/.*', (match, response) => {
  // see tutorial for more details
})

client.record.unlisten(pattern)

client.record.unlisten('raceHorse/.*')

Removes a listener that was previously registered using listen().