Abstract
Protected
constructorStatic
Readonly
CollectionStatic
Readonly
PersistentReturns the collection attribute type
Returns the persistent attribute type
Abstract
getGets this attribute value form the object as json
The converted json value
The root object state
The object which contains the value of this attribute
additional options which are applied through the conversion
Optional
depth?: number | booleanOptional
excludeThe type that owns this attribute
Position of the attribute
Protected
keyAbstract
setSets this attribute value from json to the object
The root state
The object which contains the attribute
The json value to convert an set
additional options which are applied through the conversion
Optional
onlyStatic
attachAttach and returns the the given size on the collection, in a meaner that it isn't enumerable
The actual or new attached size whenever a new size was provided or not
The collection where the size is attached on
Optional
size: numberThe size which should be attached, the previously attached size will be returned if omitted
Static
attachAttach and returns the attached state of the given object or collection
The actual or new attached state whenever an existing state was found
The object or collection on which the state is attached
The new state which should be attached to the object
Optional
overwriteExistingValue: booleanIf true, overwrites any existing attached state with the given new state, if false any previously attached state will kept and will be returned instead
Retrieves the attached state of the given object or collection
The actual attached state or undefined if no previous state was attached
The object or collection on which the state is attached
Generated using TypeDoc
the name of the attribute