Home Reference Source Repository
import {Base} from 'udata/js/models/base.js'
public class | source

Base

Direct Subclass:

List, Model

Indirect Subclass:

ModelPage, PageList

Common class behaviors.

Provide:

- PubSub
- Scoped API access
- Vue.js compatible setter

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

$pubsub: *

Method Summary

Public Methods
public

$api(endpoint: String, data: Object, callback: Function): *

Call an API endpoint.
public

$emit(name: String, args: Array)

Emit an event on this model instance
public

$off(name: String, handler: Function): *

Unregister a listener on an event.
public

$on(name: String, handler: Function): Object

Register a listener on an event.
public

$once(name: String, handler: Function): *

Register once a listener on an event.

Public Constructors

public constructor source

Public Members

public $pubsub: * source

Public Methods

public $api(endpoint: String, data: Object, callback: Function): * source

Call an API endpoint. Callbacks are scoped to the model instance.

Params:

NameTypeAttributeDescription
endpoint String

The API endpoint to call

data Object

The data object to submit

callback Function

The callback function to call on success.

Return:

*

public $emit(name: String, args: Array) source

Emit an event on this model instance

Params:

NameTypeAttributeDescription
name String

The event unique name

args Array

A variable number of parameters

public $off(name: String, handler: Function): * source

Unregister a listener on an event.

Params:

NameTypeAttributeDescription
name String

The event name to subscribe

handler Function

The callback to register

Return:

*

public $on(name: String, handler: Function): Object source

Register a listener on an event.

Params:

NameTypeAttributeDescription
name String

The event name to subscribe

handler Function

The callback to register

Return:

Object

An object with a single method remove allowing to unregister the callback

public $once(name: String, handler: Function): * source

Register once a listener on an event.

Params:

NameTypeAttributeDescription
name String

The event name to subscribe

handler Function

The callback to register

Return:

*