Skip to content

Commit 4dd17f2

Browse files
committed
Property details
1 parent 35f8f10 commit 4dd17f2

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,24 +51,75 @@ var strXML = objSerializer.GetXMLString('objTest');
5151

5252
## Preferences
5353
- SmartIndent
54+
Boolean, default false
55+
If the output is indented by tabs. This preference only applies to the GetXMLString() method.
5456
- ShowLineBreaks
57+
Boolean, default false
58+
If the output contains line breaks.
5559
- ShowTypes
60+
Boolean, default false
61+
If the output contains types. This preference only applies to the GetXMLString() method.
62+
63+
### Preferences Usage
64+
```
65+
objSerializer.Prefs.SmartIndent = true;
66+
```
5667

5768
## Types
5869
- UseNull
70+
Boolean, default true
71+
If Null properties of the object being serialized are included.
5972
- UseUndefined
73+
Boolean, default true
74+
If Undefined properties of the object being serialized are included.
6075
- UseArray
76+
Boolean, default true
77+
If Array properties of the object being serialized are included.
6178
- UseObject
79+
Boolean, default true
80+
If Object properties of the object being serialized are included.
6281
- UseBoolean
82+
Boolean, default true
83+
If Boolean properties of the object being serialized are included.
6384
- UseDate
85+
Boolean, default true
86+
If Date properties of the object being serialized are included.
6487
- UseError
88+
Boolean, default true
89+
If Error properties of the object being serialized are included.
6590
- UseFunction
91+
Boolean, default true
92+
If Function properties of the object being serialized are included.
6693
- UseNumber
94+
Boolean, default true
95+
If Number properties of the object being serialized are included.
6796
- UseRegExp
97+
Boolean, default true
98+
If RegExp properties of the object being serialized are included.
6899
- UseString
100+
Boolean, default true
101+
If String properties of the object being serialized are included.
69102
- UseUserDefined
103+
Boolean, default true
104+
If user defined Objects that are properties of the object being serialized are included.
70105
- UseObjectsForUserDefined
106+
If user defined Objects are declared as their defined type, or if they are serialized as Object properties.
107+
Boolean, default false
108+
109+
### Types Usage
110+
```
111+
objSerializer.Types.UseNull = false;
112+
```
71113

72114
## Rules
73115
- CheckInfiniteLoops
116+
Boolean, default true
117+
Check for infinte loops where child properties can reference parent objects, and exclude child properties in this case.
74118
- MaxDepth
119+
Integer, default null
120+
Maximum depth of child properties to serialize. If left as Null then this value is ignored, and no check is performed.
121+
122+
### Rules Usage
123+
```
124+
objSerializer.CheckInfiniteLoops = false;
125+
```

0 commit comments

Comments
 (0)