Home Reference Source Test Repository
import Dataset from 'jexia-sdk-js/src/Dataset.js'
public class | source

Dataset

Dataset CRUD operations and realtime subscriptions

Constructor Summary

Public Constructor
public

constructor(name: string, client: Object)

Create a dataset object with some initial values.

Member Summary

Public Members
public
public
public
public
public

Method Summary

Public Methods
public

Create a new record on the dataset

public

Delete a record from the dataset

public

Get a record from a dataset

public

Get information about the dataset, such as total records

public

List all records

public

Query a dataset with query parameters

public

subscribe(args: ...args): Object

Subscribe to realtime notfications The event name can be: 1.

public

unsubscribe(args: ...args)

Unsubscribe from realtime notfications

public

Update a record on the dataset

Public Constructors

public constructor(name: string, client: Object) source

Create a dataset object with some initial values.

Params:

NameTypeAttributeDescription
name string

Name of the dataset

client Object

JexiaClient

Public Members

public app: Object source

public auth: Object source

public bus: Object source

public name: string source

public rtc: Object source

Public Methods

public create(data: Object): Promise<Object, Error> source

Create a new record on the dataset

Params:

NameTypeAttributeDescription
data Object

Row data

Return:

Promise<Object, Error>

Example:

dataset.create({value: test}).then(function(res) {
   console.log(res);
});

public delete(id: string): Promise<Object, Error> source

Delete a record from the dataset

Params:

NameTypeAttributeDescription
id string

record id

Return:

Promise<Object, Error>

Example:

dataset.delete('s6svsrw452rwfs').then(function(res) {
   console.log(res);
});

public get(id: string): Promise<Object, Error> source

Get a record from a dataset

Params:

NameTypeAttributeDescription
id string

record id

Return:

Promise<Object, Error>

Example:

dataset.get('s6svsrw452rwfs').then(function(res) {
   console.log(res);
});

public info(): Promise<Object, Error> source

Get information about the dataset, such as total records

Return:

Promise<Object, Error>

Example:

dataset.info().then(function(res) {
   console.log(res);
});

public list(): Promise<Array, Error> source

List all records

Return:

Promise<Array, Error>

Example:

dataset.list().then(function(res) {
   console.log(res);
});

public query(params: Object): Promise<Array, Error> source

Query a dataset with query parameters

Params:

NameTypeAttributeDescription
params Object

query params

Return:

Promise<Array, Error>

Example:

dataset.query({limit: 1}).then(function(res) {
   console.log(res);
});

public subscribe(args: ...args): Object source

Subscribe to realtime notfications The event name can be:

  1. None => Any kind of activity
  2. '*' => Any kind of activity
  3. 'created' => Only created rows
  4. 'updated' => Only updated rows
  5. 'deleted' => Only deleted rows

Params:

NameTypeAttributeDescription
args ...args

Event name and callback function

Return:

Object

Dataset

Emit:

jexia.dataset.subscription

emit a new subscription event

Example:

Subscribe to all events:
dataset.subscribe(function(data) {
    console.log(data);
});

Subscribe to created events:
dataset.subscribe('created', function(data) {
    console.log(data);
});

Subscribe to updated events:
dataset.subscribe('updated', function(data) {
    console.log(data);
});

Subscribe to deleted events:
dataset.subscribe('deleted', function(data) {
    console.log(data);
});

public unsubscribe(args: ...args) source

Unsubscribe from realtime notfications

Params:

NameTypeAttributeDescription
args ...args

Event name and callback function

Example:

dataset.unsubscribe(function(data) {
    console.log(data);
});

public update(id: string, data: Object): Promise<Object, Error> source

Update a record on the dataset

Params:

NameTypeAttributeDescription
id string

record id

data Object

Data to update

Return:

Promise<Object, Error>

Example:

dataset.update('s6svsrw452rwfs', {value: test}).then(function(res) {
   console.log(res);
});