Class ParseMobx

Parse Mobx Class

Hierarchy

ParseMobx

Constructors

constructor

new ParseMobx(obj: Object<Attributes>): ParseMobx
ParseMobx Class constructor
Parameters
- obj: Object<Attributes>
Returns ParseMobx
- Defined in index.ts:40

Properties

`Private` `Readonly` attributes

attributes: Attributes

Contains the observable attributes.

`Private` `Readonly` id

id: string

Parse Object Id.

loading

loading: boolean = false

Will set to true if the object is being saved.

`Private` `Readonly` parseObj

parseObj: Object<Attributes>

The parse Object

Methods

add

add(attr: string, item: any): ParseMobx
Atomically add an object to the end of the array associated with a given key.

Returns
Parameters
- attr: string
- item: any
Returns ParseMobx
- Defined in index.ts:131

addAll

addAll(attr: string, items: any[]): ParseMobx
Atomically add the objects to the end of the array associated with a given key.

Returns
Parameters
- attr: string
- items: any[]
Returns ParseMobx
- Defined in index.ts:145

addAllUnique

addAllUnique(attr: string, items: any[]): ParseMobx
Atomically add the objects to the array associated with a given key, only if it is not already present in the array. The position of the insert is not guaranteed.

Returns
Parameters
- attr: string
- items: any[]
Returns ParseMobx
- Defined in index.ts:160

addUnique

addUnique(key: string, value: any): ParseMobx
Atomically add an object to the array associated with a given key, only if it is not already present in the array. The position of the insert is not guaranteed.

Returns
Parameters
- key: string
- value: any
Returns ParseMobx
- Defined in index.ts:183

`Private` checkDefined

checkDefined(key: string, initValue: any): void
Private
Check if a value is undefined and create the attribute for it with a default value/
Parameters
- key: string
- initValue: any
Returns void
- Defined in index.ts:691

`Private` checkType

checkType(key: string, type: string): boolean
Private
returns the type of attribute's value

Returns
Parameters
- key: string
- type: string
Returns boolean
- Defined in index.ts:706

clear

clear(options: any): any
Clear Parse Object

Returns
Parameters
- options: any
Returns any
- Defined in index.ts:202

clone

clone(): ParseMobx
Returns

Returns ParseMobx
- Defined in index.ts:210

decrement

decrement(attr: string, amount?: number): false | ParseMobx
Returns
Parameters
- attr: string
- Optional amount: number
Returns false | ParseMobx
- Defined in index.ts:378

destroy

destroy(options?: DestroyOptions): Promise<Object<Attributes>>
Destroy Object on the server.

Returns
Parameters
- Optional options: DestroyOptions
Returns Promise<Object<Attributes>>
- Defined in index.ts:219

destroyEventually

destroyEventually(options?: DestroyOptions): Promise<Object<Attributes>>
Eventually Destroy an object on the server

Returns
Parameters
- Optional options: DestroyOptions
Returns Promise<Object<Attributes>>
- Defined in index.ts:228

dirty

dirty(attr?: string): boolean
Returns
Parameters
- Optional attr: string
Returns boolean
- Defined in index.ts:237

dirtyKeys

dirtyKeys(): string[]
Returns

Returns string[]
- Defined in index.ts:245

equals

equals<T>(other: T): boolean
Returns
Type Parameters
- T extends Object<Attributes, T>
Parameters
- other: T
Returns boolean
- Defined in index.ts:254

escape

escape(attr: string): string
Returns
Parameters
- attr: string
Returns string
- Defined in index.ts:263

existed

existed(): boolean
Returns

Returns boolean
- Defined in index.ts:271

exists

exists(options?: RequestOptions): Promise<boolean>
Returns
Parameters
- Optional options: RequestOptions
Returns Promise<boolean>
- Defined in index.ts:280

fetch

fetch(options?: FetchOptions): Promise<ParseMobx>
Returns
Parameters
- Optional options: FetchOptions
Returns Promise<ParseMobx>
- Defined in index.ts:289

fetchFromLocalDatastore

fetchFromLocalDatastore(): Promise<Object<Attributes>>
Returns

Returns Promise<Object<Attributes>>
- Defined in index.ts:302

fetchWithInclude

fetchWithInclude<K>(keys: K | (K | K[])[], options?: RequestOptions): Promise<ParseMobx>
Returns
Type Parameters
- K extends string
Parameters
- keys: K | (K | K[])[]
- Optional options: RequestOptions
Returns Promise<ParseMobx>
- Defined in index.ts:312

get

get(key: string): any
Returns
Parameters
- key: string
Returns any
- Defined in index.ts:326

getACL

getACL(): undefined | ACL
Returns

Returns undefined | ACL
- Defined in index.ts:342

getId

getId(): string
Return the id of the parse object.

Returns

Returns string
- Defined in index.ts:334

getParseObject

getParseObject(): Object<Attributes>
Returns

Returns Object<Attributes>
- Defined in index.ts:681

has

has(attr: string): boolean
Returns
Parameters
- attr: string
Returns boolean
- Defined in index.ts:351

increment

increment(attr: string, amount?: number): false | ParseMobx
Returns
Parameters
- attr: string
- Optional amount: number
Returns false | ParseMobx
- Defined in index.ts:361

initialize

initialize(): void
Returns void
- Defined in index.ts:390

isDataAvailable

isDataAvailable(): boolean
Returns

Returns boolean
- Defined in index.ts:398

isNew

isNew(): boolean
Returns

Returns boolean
- Defined in index.ts:406

isPinned

isPinned(): Promise<boolean>
Returns

Returns Promise<boolean>
- Defined in index.ts:414

isValid

isValid(): boolean
Returns

Returns boolean
- Defined in index.ts:422

newInstance

newInstance(): ParseMobx
Returns

Returns ParseMobx
- Defined in index.ts:430

op

op(attr: string): any
Returns
Parameters
- attr: string
Returns any
- Defined in index.ts:439

pin

pin(): Promise<void>
Returns

Returns Promise<void>
- Defined in index.ts:447

pinWithName

pinWithName(name: string): Promise<void>
Returns
Parameters
- name: string
Returns Promise<void>
- Defined in index.ts:456

relation

relation<R, K>(attr: K): Relation<any, R>
Returns
Type Parameters
- R extends Object<Attributes, R>
- K extends string = string
Parameters
- attr: K
Returns Relation<any, R>
- Defined in index.ts:465

remove

remove(key: string, value: any): ParseMobx
Returns
Parameters
- key: string
- value: any
Returns ParseMobx
- Defined in index.ts:475

removeAll

removeAll(attr: string, items: any[]): ParseMobx
Returns
Parameters
- attr: string
- items: any[]
Returns ParseMobx
- Defined in index.ts:494

revert

revert(...keys: string[]): void
Returns
Parameters
- Rest ...keys: string[]
Returns void
- Defined in index.ts:514

save

save(options?: SaveOptions): Promise<ParseMobx>
Returns
Parameters
- Optional options: SaveOptions
Returns Promise<ParseMobx>
- Defined in index.ts:528

saveEventually

saveEventually(options?: SaveOptions): Promise<ParseMobx>
Returns
Parameters
- Optional options: SaveOptions
Returns Promise<ParseMobx>
- Defined in index.ts:555

set

set(key: string, value: any, options?: SetOptions): ParseMobx
Returns
Parameters
- key: string
- value: any
- Optional options: SetOptions
Returns ParseMobx
- Defined in index.ts:584

setACL

setACL(acl: ACL, options?: SuccessFailureOptions): false | ParseMobx
Returns
Parameters
- acl: ACL
- Optional options: SuccessFailureOptions
Returns false | ParseMobx
- Defined in index.ts:615

toJSON

toJSON(): ToJSON<Attributes> & JSONBaseAttributes
Returns

Returns ToJSON<Attributes> & JSONBaseAttributes
- Defined in index.ts:624

toPointer

toPointer(): Pointer
Returns

Returns Pointer
- Defined in index.ts:632

unPin

unPin(): Promise<void>
Returns

Returns Promise<void>
- Defined in index.ts:640

unPinWithName

unPinWithName(name: string): Promise<void>
Returns
Parameters
- name: string
Returns Promise<void>
- Defined in index.ts:649

unset

unset(attr: string, options?: any): ParseMobx
Returns
Parameters
- attr: string
- Optional options: any
Returns ParseMobx
- Defined in index.ts:659

validate

validate(attrs: Attributes, options?: SuccessFailureOptions): false | Error
Returns
Parameters
- attrs: Attributes
- Optional options: SuccessFailureOptions
Returns false | Error
- Defined in index.ts:673

`Static` deleteListItemById

deleteListItemById(list: ParseMobx[], item: ParseMobx): void
Delete an Item from a list of observable ParseMobx

Static
Parameters
- list: ParseMobx[]
- item: ParseMobx
Returns void
- Defined in index.ts:107

`Static` toParseMobx

toParseMobx(param: any): null | ParseMobx | ParseMobx[] | ((obj: Object<Attributes>) => any)
Convert a ParseObject or array of ParseObjects to ParseMobx object or array of ParseMobx objects.

Static

Returns
Parameters
- param: any
Returns null | ParseMobx | ParseMobx[] | ((obj: Object<Attributes>) => any)
- Defined in index.ts:89

`Static` updateListItem

updateListItem(list: ParseMobx[], item: ParseMobx): void
Update an Item in the list of parse mobx observable list.

Deprecated

Static
Parameters
- list: ParseMobx[]
- item: ParseMobx
Returns void
- Defined in index.ts:121

Generated using TypeDoc