Class: Field
item.Field
Hierarchy
-
↳
Field
Constructors
constructor
• new Field(vals?)
Parameters
| Name | Type |
|---|---|
vals |
Partial<Field> |
Overrides
Defined in
Properties
_propertySerializationOptions
• _propertySerializationOptions:
SerializationOptions[]
Inherited from
Serializable._propertySerializationOptions
Defined in
name
• name: string = ""
field name
Defined in
type
• type: FieldType = FieldType.Text
field type, determining meta data via the corresponding field definition in FIELD_DEFS
Defined in
value
• value: string = ""
field content
Defined in
Accessors
def
• get def(): FieldDef
Returns
Defined in
icon
• get icon(): string
Returns
string
Defined in
kind
• get kind(): string
A string representing the objects "type", useful for segmenting storage, among other things. Defaults to the lowercase class name, but can be overwritten by subclasses
Returns
string
Inherited from
Serializable.kind
Defined in
Methods
_fromRaw
▸ Protected _fromRaw(raw): void
Restore values from a raw object. The default implementation simply copies over all iterable properties from the base object. Overwrite this method for properties that require special treatment
Parameters
| Name | Type |
|---|---|
raw |
any |
Returns
void
Overrides
Defined in
_toRaw
▸ Protected _toRaw(version): any
Transform this object into a raw javascript object used for serialization. The default implementation simply copies all iterable properties not included in the [[exlude]] array and calls toRaw on any properties that are themselfes instances of Serializable. This method should be overwritten by subclasses if certain properties require special treatment.
Parameters
| Name | Type |
|---|---|
version |
undefined | string |
Returns
any
Inherited from
Defined in
clone
▸ clone(): Field
Creates a deep clone of the object
Returns
Inherited from
Defined in
format
▸ format(masked): string
Parameters
| Name | Type |
|---|---|
masked |
boolean |
Returns
string
Defined in
fromBytes
▸ fromBytes(bytes): Field
Deserializes the object from a byte array
Parameters
| Name | Type |
|---|---|
bytes |
Uint8Array |
Returns
Inherited from
Defined in
fromJSON
▸ fromJSON(json): Field
Deserializes the object from a JSON string
Parameters
| Name | Type |
|---|---|
json |
string |
Returns
Inherited from
Defined in
fromRaw
▸ fromRaw(raw): Field
Restores propertiers from a raw object of the same form generated by
toRaw. The base implementation blindly copies over values
from the raw object via Object.assign so subclasses should explictly process
any propertyies that need special treatment.
Also takes are of validation and "upgrading" in case the raw object has an old version. Use the protected _fromRaw method to implement subclass-specific behavior.
Parameters
| Name | Type |
|---|---|
raw |
any |
Returns
Inherited from
Defined in
toBytes
▸ toBytes(): Uint8Array
Returns a serialization of the object in form of a byte array
Returns
Uint8Array
Inherited from
Defined in
toJSON
▸ toJSON(): string
Returns a JSON serialization of the object
Returns
string
Inherited from
Defined in
toRaw
▸ toRaw(version?): any
Creates a raw javascript object representation of the class, which can be used for storage or data transmission. Also handles "downgrading" to previous versions. Use _toRaw for subclass-specific behavior.
Parameters
| Name | Type |
|---|---|
version? |
string |
Returns
any
Inherited from
Defined in
transform
▸ transform(): Promise<string>
Returns
Promise<string>
Defined in
validate
▸ validate(): boolean
This is called during deserialization and should verify that all properties have been populated with values of the correct type. Subclasses should implement this method based on their class structure.
Returns
boolean