ViewModelCache

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

ViewModelCache<ViewModelClassType>

API

Constructor

new ViewModelCache(viewModel)

Arguments:

	Argument	Type	Description
*	viewModel	ViewModelClassType

Methods

add(...)

Documentation for each typescript overload shown below:

add<T>(data)

Source

Arguments:

	Argument	Type	Description
*	data	T

Returns:T

add<FieldNames>(data)

Source

Arguments:

	Argument	Type	Description
*	data	mapped

Returns:PartialViewModel

addList(...)

Documentation for each typescript overload shown below:

addList<T>(records)

Source

Arguments:

	Argument	Type	Description
*	records	T[]

Returns:T[]

addList<FieldNames>(records)

Source

Arguments:

	Argument	Type	Description
*	records	mapped[]

Returns:PartialViewModel[]

addListener(...)

Documentation for each typescript overload shown below:

addListener(listener)

Source

Arguments:

	Argument	Type	Description
*	listener	() => void

Returns:() => void

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

Source

Arguments:

	Argument	Type
*	pk	PkType
*	fieldNames	T[]
*	listener	(previous?: T \| null \| undefined, next?: T \| null \| undefined) => void
	batch	boolean

Returns:() => void

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

Source

Arguments:

	Argument	Type
*	pks	PkType[]
*	fieldNames	T[]
*	listener	(previous?: (T \| null)[] \| undefined, next?: (T \| null)[] \| undefined) => void
	batch	boolean

Returns:() => void

addListenerList(...)

Documentation for each typescript overload shown below:

addListenerList<T>(pks,fieldNames,listener)

Source

Arguments:

	Argument	Type
*	pks	PkType[]
*	fieldNames	T[]
*	listener	(previous?: (T \| null)[] \| undefined, next?: (T \| null)[] \| undefined) => void

Returns:() => void

batch<T>(run)

Source

Arguments:

	Argument	Type	Description
*	run

Returns:T

delete(pk,?fieldNames)

Source

Arguments:

	Argument	Type	Description
*	pk	PkType
	fieldNames	'*'\|[string\|string[]][]

Returns:boolean

deleteAll(?fieldNames)

Source

Arguments:

	Argument	Type	Description
	fieldNames	'*'\|[string\|string[]][]

Returns:void

get(...)

Documentation for each typescript overload shown below:

get<T>(pk,fieldNames)

Source

Arguments:

	Argument	Type	Description
*	pk	PkType
*	fieldNames	T[]

Returns:null|PartialViewModel

get<T>(record)

Source

Arguments:

	Argument	Type	Description
*	record	PartialViewModel

Returns:null|PartialViewModel

getAll(...)

Documentation for each typescript overload shown below:

getAll(fieldNames)

Source

Arguments:

	Argument	Type	Description
*	fieldNames	"*"

Returns:PartialViewModel[]

getAll<T>(fieldNames)

Source

Arguments:

	Argument	Type	Description
*	fieldNames	T[]

Returns:PartialViewModel[]

getList(...)

Documentation for each typescript overload shown below:

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

Source

Arguments:

	Argument	Type
*	pks	PkType[]
*	fieldNames	T[]
	removeNulls	RemoveNullsT

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

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

Source

Arguments:

	Argument	Type	Description
*	records	T[]
	removeNulls	RemoveNullsT

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

Properties

viewModel

Source

ViewModelClassType

On this page

API

Constructor

Arguments:

Methods

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Properties

viewModel