Home Reference Source
import BOOLEAN from 'observabubble/props/Boolean.js'
public class | source

BOOLEAN

Extends:

PropEventsProp → BOOLEAN

Constructor Summary

Public Constructor
public

constructor(value: Boolean, options: Object)

Method Summary

Public Methods
public

format(): *

public

parse(value: Boolean): Boolean

Removes the first item of the Array and returns that item

public

toggle()

Inherited Summary

From class PropEvents
public
public
public

parent: *

private

_event: {}

public

off(eventName: Event, callback: Function)

Unbinds an event listener

public

on(eventName: Event, callback: Function)

Bind an event listener

private

_bubble(eventName: Event, target: Prop)

Calls event bubbling on the parent Observable

private

async _processEvent(eventName: Event, target: Prop, additional: Object)

Calls the listeners for the Event triggered

From class Prop
public static

isProp: *

public

name: *

public

value: *

public

[Symbol.toPrimitive](hint: *): *

public

equals(data: *): *

public

format(): *

public

get(): *

public

parse(value: *): *

public

toJSON(): *

public

toString(): *

public

valueOf(): *

private

_set(value: *, objectPattern1: {"preventEvent": *})

Public Constructors

public constructor(value: Boolean, options: Object) source

Override:

Prop#constructor

Params:

NameTypeAttributeDescription
value Boolean

The initial value of the Boolean

options Object
options.parent OBJECT

The Parent Object to which this Array is a member of

options.name String

The Name/key in the Parent Object to which this Array is assigned

Public Methods

public format(): * source

Override:

Prop#format

Return:

*

public parse(value: Boolean): Boolean source

Removes the first item of the Array and returns that item

Override:

Prop#parse

Params:

NameTypeAttributeDescription
value Boolean

If true then the Change event is not fired

Return:

Boolean

value - The Observalbe Object of the item removed from the array

public toggle() source