Skip to content

Commit 79a8dde

Browse files
committed
update docs
1 parent f5cd5a5 commit 79a8dde

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Note: Due to some last quick changes on v4, detail of v4.5.3 & v4.5.4 are not up
1515
- if processEntities is true, but you dont pass entity decoder separately then performance may degrade by approx 8-10%
1616
- if processEntities is true, and you pass entity decoder separately
1717
- if no entity then performance should be same as before
18-
- if there are entities then performance should be increased
18+
- if there are entities then performance should be increased from past versions
19+
- ignoreAttributes is not required to be set to set xml version for NCR entity value
1920

2021
**5.6.0 / 2026-04-15**
2122
- fix: entity replacement for numeric entities

docs/v4, v5/2.XMLparseOptions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -367,16 +367,18 @@ type EntityDecoderOptions = {
367367

368368
We're not explicitely checking the type and required methods but parser may throw error if the provided object doesn't have the required methods.
369369

370-
If XML document has version attribute in xml declaration then it will be passed to `setXmlVersion` method of the decoder to handle NCR gradefully.
370+
If XML document has version attribute in xml declaration then it will be passed to `setXmlVersion` method of the decoder to handle NCR gracefully. You dont have to set `ignoreAttributes` to `false` to read attributes from xml decalaration.
371371

372372
When `processEntities` is set to `false` then `entityDecoder` will not be used. But if 'true' and `entityDecoder` is not provided then default entity decoder (`@nodable/entities`) will be used.
373373

374-
When `entityDecoder` is provided then following options which are set ot parser directly will be ignored. User is expected them to set them in decoder's config.
374+
When `entityDecoder` is provided then following options which are set to parser directly will be ignored. User is expected them to set right config in decoder's config.
375375
- htmlEntities
376376
- maxTotalExpansions
377377
- maxExpandedLength
378378

379+
If your XML has NCR(Numeric Character Reference) in XML document then the response can be changed baced on XML version read from declaration tag. If not set then '1.0' is considered as default
379380

381+
You can read more detail for advance handling in [@nodable/entities](https://github.com/nodable/val-parsers/blob/main/Entity/docs/EntityDecoder.md) configuration.
380382

381383

382384
## ignoreAttributes

0 commit comments

Comments
 (0)