ReadUnionInstance
Defined in: runtime/union.ts:5
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”TReadItem
Section titled “TReadItem”TReadItem extends ReadItem = ReadItem
Properties
Section titled “Properties”
readonlyprn:string
Defined in: runtime/index.ts:43
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”getItem()
Section titled “getItem()”getItem(
id):Promise<TReadItem|undefined>
Defined in: runtime/union.ts:23
Returns the item of the given identifier if it is of the type of this union. If the item does not exist, there are insufficient permissions, or the union does not match; will result in undefined.
Parameters
Section titled “Parameters”Identifier
Returns
Section titled “Returns”Promise<TReadItem | undefined>
isMember()
Section titled “isMember()”isMember(
template):boolean
Defined in: runtime/union.ts:6
Parameters
Section titled “Parameters”template
Section titled “template”Returns
Section titled “Returns”boolean
isType()
Section titled “isType()”isType(
value):value is TReadItem
Defined in: runtime/union.ts:11
Returns true if the supplied item is of the type of this union.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”value is TReadItem
memberPrns()
Section titled “memberPrns()”memberPrns():
string[]
Defined in: runtime/union.ts:16
Returns the member template prns of this union
Returns
Section titled “Returns”string[]
selectItems()
Section titled “selectItems()”selectItems():
UnionCursorSelector<ReadItem>
Defined in: runtime/union.ts:25