On this page

Field notation
Methods
Properties
- cache
- viewModel
Static Properties
- listenerBatcher

ViewModelCache

import { ViewModelCache } from "@prestojs/viewmodel";

ViewModelCache<ViewModelClassType>

API

Show inherited

Constructor

new ViewModelCache(viewModel)

Params:

	Parameter	Type	Description
*	viewModel	ViewModelClassType

Methods

add<T>(recordOrData)

Params:

	Parameter	Type	Description
*	recordOrData	T

Returns:T

add<T>(recordOrData)

Params:

	Parameter	Type	Description
*	recordOrData	T[]

Returns:T[]

add<FieldNames>(recordOrData)

Params:

	Parameter	Type	Description
*	recordOrData	mapped

Returns:PartialViewModel

add<FieldNames>(recordOrData)

Params:

	Parameter	Type	Description
*	recordOrData	mapped[]

Returns:PartialViewModel[]

addList<T>(recordsOrData)

Params:

	Parameter	Type	Description
*	recordsOrData	T[]

Returns:T[]

addList<FieldNames>(recordsOrData)

Params:

	Parameter	Type	Description
*	recordsOrData	mapped[]

Returns:PartialViewModel[]

addListener(listener)

Params:

	Parameter	Type	Description
*	listener	AllChangesListener

Returns:ChangeListenerUnsubscribe

addListener<T>(pkOrPks,fieldNames,listener,?batch)

Params:

	Parameter	Type	Description
*	pkOrPks	Object\|mapped
*	fieldNames	T[]
*	listener	ChangeListener
	batch	boolean

Returns:ChangeListenerUnsubscribe

addListener(pkOrPks,fieldNames,listener,?batch)

Params:

	Parameter	Type	Description
*	pkOrPks	Object\|mapped
*	fieldNames	"*"
*	listener	ChangeListener
	batch	boolean

Returns:ChangeListenerUnsubscribe

addListener<T>(pkOrPks,fieldNames,listener,?batch)

Params:

	Parameter	Type	Description
*	pkOrPks	(Object\|mapped)[]
*	fieldNames	T[]
*	listener	MultiChangeListener
	batch	boolean

Returns:ChangeListenerUnsubscribe

addListener(pkOrPksOrListener,fieldNames,listener,?batch)

Params:

	Parameter	Type	Description
*	pkOrPksOrListener	(Object\|mapped)[]
*	fieldNames	"*"
*	listener	MultiChangeListener
	batch	boolean

Returns:ChangeListenerUnsubscribe

addListenerList<T>(pks,fieldNames,listener)

Params:

	Parameter	Type	Description
*	pks	(Object\|mapped)[]
*	fieldNames	T[]
*	listener	MultiChangeListener

Returns:ChangeListenerUnsubscribe

addListenerList(pks,fieldNames,listener)

Params:

	Parameter	Type	Description
*	pks	(Object\|mapped)[]
*	fieldNames	"*"
*	listener	MultiChangeListener

Returns:ChangeListenerUnsubscribe

batch<T>(run)

Params:

	Parameter	Type	Description
*	run

Returns:T

delete(pk,?fieldNames)

Params:

	Parameter	Type	Description
*	pk	Object\|mapped
	fieldNames	'*'\|[string\|string[]][]

Returns:boolean

get<T>(pk,fieldNames)

Params:

	Parameter	Type	Description
*	pk	Object\|mapped
*	fieldNames	T[]

Returns:null|PartialViewModel

get(pk,fieldNames)

Params:

	Parameter	Type	Description
*	pk	Object\|mapped
*	fieldNames	"*"

Returns:null|PartialViewModel

get<T>(record)

Params:

	Parameter	Type	Description
*	record	PartialViewModel

Returns:null|PartialViewModel

getAll(fieldNames)

Params:

	Parameter	Type	Description
*	fieldNames	"*"

Returns:PartialViewModel[]

getAll<T>(fieldNames)

Params:

	Parameter	Type	Description
*	fieldNames	T[]

Returns:PartialViewModel[]

getList<T,RemoveNullsT = true>(pks,fieldNames,?removeNulls)

Params:

	Parameter	Type	Description
*	pks	(Object\|mapped)[]
*	fieldNames	T[]
	removeNulls	RemoveNullsT

Returns:PartialViewModel[]|(null|PartialViewModel)[]

getList<RemoveNullsT = true>(pks,fieldNames,?removeNulls)

Params:

	Parameter	Type	Description
*	pks	(Object\|mapped)[]
*	fieldNames	"*"
	removeNulls	RemoveNullsT

Returns:PartialViewModel[]|(null|PartialViewModel)[]

getList<T,RemoveNullsT = true>(records,?removeNulls)

Params:

	Parameter	Type	Description
*	records	T[]
	removeNulls	RemoveNullsT

Returns:T[]|(null|T)[]

getList<T,RemoveNullsT = true>(records,?removeNulls)

Params:

	Parameter	Type	Description
*	records	PartialViewModel[]
	removeNulls	RemoveNullsT

Returns:PartialViewModel[]|(null|PartialViewModel)[]

Properties

cache

never

viewModel

ViewModelClassType

Static Properties

listenerBatcher

An object with these properties:
	Property	Type	Description
*	batch
*	call
*	callAll
	isActive	boolean
	pending	Map
	pendingAll	Set
	pendingNoBatch	Map