Class ParseMobx

Parse Mobx Class

Constructors

constructor

new ParseMobx(obj: Object): ParseMobx
ParseMobx Class constructor
Parameters
- obj: Object
Returns ParseMobx
- Defined in index.ts:44

Properties

loading

loading: boolean = false

Will set to true if the object is being saved.

Methods

_clearPendingOps

_clearPendingOps(): void
Clear pending operations on the Parse object

Returns void
- Defined in index.ts:705

_getId

_getId(): string
Get the internal Parse object ID

Returns string
- Defined in index.ts:716

_getStateIdentifier

_getStateIdentifier(): any
Get the internal state identifier

Returns any
- Defined in index.ts:728

add

add(attr: string, item: any): this
Atomically add an object to the end of the array associated with a given key.
Parameters
- attr: string
- item: any
Returns this
- Defined in index.ts:136

addAll

addAll(attr: string, items: any[]): this
Atomically add the objects to the end of the array associated with a given key.
Parameters
- attr: string
- items: any[]
Returns this
- Defined in index.ts:150

addAllUnique

addAllUnique(attr: string, items: any[]): this
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.
Parameters
- attr: string
- items: any[]
Returns this
- Defined in index.ts:165

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.
Parameters
- key: string
- value: any
Returns ParseMobx
- Defined in index.ts:188

clear

clear(options: any): any
Clear Parse Object
Parameters
- options: any
Returns any
- Defined in index.ts:206

clone

clone(): ParseMobx
Returns ParseMobx
- Defined in index.ts:214

decrement

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

destroy

destroy(options?: DestroyOptions): Promise<Object<Attributes>>
Destroy Object on the server.
Parameters
- Optionaloptions: DestroyOptions
Returns Promise<Object<Attributes>>
- Defined in index.ts:223

destroyEventually

destroyEventually(options?: DestroyOptions): Promise<Object<Attributes>>
Eventually Destroy an object on the server
Parameters
- Optionaloptions: DestroyOptions
Returns Promise<Object<Attributes>>
- Defined in index.ts:232

dirty

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

dirtyKeys

dirtyKeys(): string[]
Returns string[]
- Defined in index.ts:249

equals

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

escape

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

existed

existed(): boolean
Returns boolean
- Defined in index.ts:275

exists

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

fetch

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

fetchFromLocalDatastore

fetchFromLocalDatastore(): Promise<Object<Attributes>>
Returns Promise<Object<Attributes>>
- Defined in index.ts:306

fetchWithInclude

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

get

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

getACL

getACL(): undefined | ACL
Returns undefined | ACL
- Defined in index.ts:346

getId

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

Returns string
- Defined in index.ts:338

getParseObject

getParseObject(): Object
Returns Object
- Defined in index.ts:698

has

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

increment

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

initialize

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

isDataAvailable

isDataAvailable(): boolean
Returns boolean
- Defined in index.ts:402

isNew

isNew(): boolean
Returns boolean
- Defined in index.ts:410

isPinned

isPinned(): Promise<boolean>
Returns Promise<boolean>
- Defined in index.ts:418

isValid

isValid(): boolean
Returns boolean
- Defined in index.ts:426

newInstance

newInstance(): ParseMobx
Returns ParseMobx
- Defined in index.ts:434

op

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

pin

pin(): Promise<void>
Returns Promise<void>
- Defined in index.ts:451

pinWithName

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

relation

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

remove

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

removeAll

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

revert

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

save

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

saveEventually

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

set

set(key: string, value: any, options?: SetOptions): this
Parameters
- key: string
- value: any
- Optionaloptions: SetOptions
Returns this
- Defined in index.ts:589

setACL

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

toJSON

toJSON(): ToJSON<Attributes> & JSONBaseAttributes
Returns ToJSON<Attributes> & JSONBaseAttributes
- Defined in index.ts:628

toOfflinePointer

toOfflinePointer(): Pointer
Creates an offline pointer to this object

Returns Pointer
- Defined in index.ts:644

toPointer

toPointer(): Pointer
Returns Pointer
- Defined in index.ts:636

unPin

unPin(): Promise<void>
Returns Promise<void>
- Defined in index.ts:657

unPinWithName

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

unset

unset(attr: string, options?: any): this
Parameters
- attr: string
- Optionaloptions: any
Returns this
- Defined in index.ts:676

validate

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

`Static`deleteListItemById

deleteListItemById(list: ParseMobx[], item: ParseMobx): void
Delete an Item from a list of observable ParseMobx
Parameters
- list: ParseMobx[]
- item: ParseMobx
Returns void
Static
- Defined in index.ts:111

`Static`toParseMobx

toParseMobx(param: any): null | ParseMobx | ParseMobx[] | (obj: Object) => any
Convert a ParseObject or array of ParseObjects to ParseMobx object or array of ParseMobx objects.
Parameters
- param: any
Returns null | ParseMobx | ParseMobx[] | (obj: Object) => any
Static
- Defined in index.ts:93

`Static`updateListItem

updateListItem(list: ParseMobx[], item: ParseMobx): void
Update an Item in the list of parse mobx observable list.
Parameters
- list: ParseMobx[]
- item: ParseMobx
Returns void
Deprecated
Static
- Defined in index.ts:125