Serializer class
Nyers válaszobjektumok végleges alakzatokra való leképezésére szolgál. Segít a dátumok és más kódolt típusok csomagolásában és kicsomagolásában, amelyek nem kapcsolódnak a JSON-hoz. Emellett lehetővé teszi az értékek lekérését a fejlécekből, valamint az alapértelmezett értékek és állandók beszúrását.
Konstruktorok
| Serializer({[key: string]: any}, boolean) |
Tulajdonságok
| isXML | Függetlenül attól, hogy a tartalom XML-e vagy sem. |
| model |
A megadott modell-leképező. |
Metódusok
| deserialize(Mapper, unknown, string, Serializer |
Deszerializálja az adott objektumot a mapperben definiált metaadatok alapján. |
| serialize(Mapper, unknown, string, Serializer |
Szerializálja az adott objektumot a mapperben definiált metaadatok alapján. |
| validate |
Érvényesíti a korlátozásokat, ha vannak ilyenek. Ez a függvény akkor jelenik meg, ha a megadott érték nem tartja tiszteletben ezeket a korlátozásokat. |
Konstruktor adatai
Serializer({[key: string]: any}, boolean)
new Serializer(modelMappers?: {[key: string]: any}, isXML?: boolean)
Paraméterek
- modelMappers
-
{[key: string]: any}
A megadott modell-leképező.
- isXML
-
boolean
Függetlenül attól, hogy a tartalom XML-e vagy sem.
Tulajdonság adatai
isXML
Függetlenül attól, hogy a tartalom XML-e vagy sem.
isXML?: boolean
Tulajdonság értéke
boolean
modelMappers
A megadott modell-leképező.
modelMappers: {[key: string]: any}
Tulajdonság értéke
{[key: string]: any}
Metódus adatai
deserialize(Mapper, unknown, string, SerializerOptions)
Deszerializálja az adott objektumot a mapperben definiált metaadatok alapján.
function deserialize(mapper: Mapper, responseBody: unknown, objectName: string, options?: SerializerOptions): any
Paraméterek
- mapper
- Mapper
A szerializálható objektum metaadatait meghatározó leképező.
- responseBody
-
unknown
Érvényes Javascript-entitás, amely deszerializálható.
- objectName
-
string
A deszerializált objektum neve.
- options
- SerializerOptions
Az XML-elemző és -szerkesztő viselkedését szabályozza.
Válaszok
any
Érvényes deszerializált Javascript-objektum.
serialize(Mapper, unknown, string, SerializerOptions)
Szerializálja az adott objektumot a mapperben definiált metaadatok alapján.
function serialize(mapper: Mapper, object: unknown, objectName?: string, options?: SerializerOptions): any
Paraméterek
- mapper
- Mapper
A szerializálható objektum metaadatait meghatározó leképező.
- object
-
unknown
Egy érvényes Javascript-objektum, amely szerializálható.
- objectName
-
string
A szerializált objektum neve.
- options
- SerializerOptions
további lehetőségek a deszerializáláshoz.
Válaszok
any
Érvényes szerializált Javascript-objektum.
validateConstraints(Mapper, unknown, string)
Figyelmeztetés
Ez az API már elavult.
Removing the constraints validation on client side.
Érvényesíti a korlátozásokat, ha vannak ilyenek. Ez a függvény akkor jelenik meg, ha a megadott érték nem tartja tiszteletben ezeket a korlátozásokat.
function validateConstraints(mapper: Mapper, value: unknown, objectName: string)
Paraméterek
- mapper
- Mapper
Az adatmodellek definíciója.
- value
-
unknown
Az érték.
- objectName
-
string
Az objektum neve. A hibaüzenetekben használatos.