@storyteller-platform/epub 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -297,7 +297,7 @@ To get started with developing in the Storyteller monorepo, check out the
297
297
 
298
298
  ## Epub
299
299
 
300
- Defined in: [libraries/epub/src/index.tsx:351](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L351)
300
+ Defined in: [libraries/epub/src/index.tsx:374](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L374)
301
301
 
302
302
  A single EPUB instance.
303
303
 
@@ -337,7 +337,7 @@ https://www.w3.org/TR/epub-33/
337
337
 
338
338
  > **new Epub**(`adapterClass`, `adapter`, `inputPath`, `readonlyOverride`): [`Epub`](#epub)
339
339
 
340
- Defined in: [libraries/epub/src/index.tsx:392](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L392)
340
+ Defined in: [libraries/epub/src/index.tsx:415](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L415)
341
341
 
342
342
  Prefer the static factories ([Epub.using](#using), [Epub.from](#from),
343
343
  [Epub.create](#create), [Epub.upgrade](#upgrade)) over calling this constructor
@@ -363,31 +363,31 @@ else should need to.
363
363
 
364
364
  > `protected` **adapter**: [`EpubStorageAdapter`](#epubstorageadapter)
365
365
 
366
- Defined in: [libraries/epub/src/index.tsx:394](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L394)
366
+ Defined in: [libraries/epub/src/index.tsx:417](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L417)
367
367
 
368
368
  #### adapterClass
369
369
 
370
370
  > `protected` **adapterClass**: [`EpubStorageAdapterClass`](#epubstorageadapterclass)
371
371
 
372
- Defined in: [libraries/epub/src/index.tsx:393](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L393)
372
+ Defined in: [libraries/epub/src/index.tsx:416](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L416)
373
373
 
374
374
  #### inputPath
375
375
 
376
376
  > `protected` **inputPath**: `string` \| `undefined`
377
377
 
378
- Defined in: [libraries/epub/src/index.tsx:395](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L395)
378
+ Defined in: [libraries/epub/src/index.tsx:418](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L418)
379
379
 
380
380
  #### readonlyOverride
381
381
 
382
382
  > `protected` **readonlyOverride**: `boolean` = `false`
383
383
 
384
- Defined in: [libraries/epub/src/index.tsx:396](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L396)
384
+ Defined in: [libraries/epub/src/index.tsx:419](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L419)
385
385
 
386
386
  #### storage
387
387
 
388
388
  > `readonly` **storage**: [`EpubStorageKind`](#epubstoragekind)
389
389
 
390
- Defined in: [libraries/epub/src/index.tsx:384](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L384)
390
+ Defined in: [libraries/epub/src/index.tsx:407](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L407)
391
391
 
392
392
  Storage backend kind in use for this instance
393
393
 
@@ -401,7 +401,7 @@ and the adapter's capability bag)
401
401
 
402
402
  > **\[dispose\]**(): `void`
403
403
 
404
- Defined in: [libraries/epub/src/index.tsx:3316](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3316)
404
+ Defined in: [libraries/epub/src/index.tsx:3373](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3373)
405
405
 
406
406
  ##### Returns
407
407
 
@@ -411,7 +411,7 @@ Defined in: [libraries/epub/src/index.tsx:3316](https://gitlab.com/storyteller-p
411
411
 
412
412
  > **addCollection**(`collection`, `index?`): `Promise`\<`void`\>
413
413
 
414
- Defined in: [libraries/epub/src/index.tsx:1941](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1941)
414
+ Defined in: [libraries/epub/src/index.tsx:1993](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1993)
415
415
 
416
416
  Add a collection to the EPUB metadata.
417
417
 
@@ -434,7 +434,7 @@ will be added to the end of the list.
434
434
 
435
435
  > **addContributor**(`contributor`, `index?`): `Promise`\<`void`\>
436
436
 
437
- Defined in: [libraries/epub/src/index.tsx:2250](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2250)
437
+ Defined in: [libraries/epub/src/index.tsx:2302](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2302)
438
438
 
439
439
  Add a contributor to the EPUB metadata.
440
440
 
@@ -464,7 +464,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
464
464
 
465
465
  > **addCreator**(`creator`, `index?`, `type?`): `Promise`\<`void`\>
466
466
 
467
- Defined in: [libraries/epub/src/index.tsx:2115](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2115)
467
+ Defined in: [libraries/epub/src/index.tsx:2167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2167)
468
468
 
469
469
  Add a creator to the EPUB metadata.
470
470
 
@@ -494,7 +494,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
494
494
 
495
495
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
496
496
 
497
- Defined in: [libraries/epub/src/index.tsx:2915](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2915)
497
+ Defined in: [libraries/epub/src/index.tsx:2967](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2967)
498
498
 
499
499
  Create a new manifest item and write its contents to a
500
500
  new entry.
@@ -523,7 +523,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
523
523
 
524
524
  > **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
525
525
 
526
- Defined in: [libraries/epub/src/index.tsx:2920](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2920)
526
+ Defined in: [libraries/epub/src/index.tsx:2972](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2972)
527
527
 
528
528
  Create a new manifest item and write its contents to a
529
529
  new entry.
@@ -552,7 +552,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
552
552
 
553
553
  > **addManifestItem**(`item`, `contents`): `Promise`\<`void`\>
554
554
 
555
- Defined in: [libraries/epub/src/index.tsx:2925](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2925)
555
+ Defined in: [libraries/epub/src/index.tsx:2977](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2977)
556
556
 
557
557
  Create a new manifest item and write its contents to a
558
558
  new entry.
@@ -580,7 +580,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
580
580
 
581
581
  > **addMetadata**(`entry`): `Promise`\<`void`\>
582
582
 
583
- Defined in: [libraries/epub/src/index.tsx:3049](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3049)
583
+ Defined in: [libraries/epub/src/index.tsx:3106](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3106)
584
584
 
585
585
  Add a new metadata entry to the Epub.
586
586
 
@@ -607,7 +607,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
607
607
 
608
608
  > **addSpineItem**(`manifestId`, `index?`): `Promise`\<`void`\>
609
609
 
610
- Defined in: [libraries/epub/src/index.tsx:2316](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2316)
610
+ Defined in: [libraries/epub/src/index.tsx:2370](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2370)
611
611
 
612
612
  Add an item to the spine of the EPUB.
613
613
 
@@ -637,7 +637,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
637
637
 
638
638
  > **addSubject**(`subject`): `Promise`\<`void`\>
639
639
 
640
- Defined in: [libraries/epub/src/index.tsx:1496](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1496)
640
+ Defined in: [libraries/epub/src/index.tsx:1538](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1538)
641
641
 
642
642
  Add a subject to the EPUB metadata.
643
643
 
@@ -659,7 +659,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
659
659
 
660
660
  > **copy**(`path?`): `Promise`\<[`Epub`](#epub)\>
661
661
 
662
- Defined in: [libraries/epub/src/index.tsx:489](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L489)
662
+ Defined in: [libraries/epub/src/index.tsx:512](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L512)
663
663
 
664
664
  ##### Parameters
665
665
 
@@ -675,7 +675,7 @@ Defined in: [libraries/epub/src/index.tsx:489](https://gitlab.com/storyteller-pl
675
675
 
676
676
  > **createXhtmlDocument**(`body`, `head?`, `language?`): `Promise`\<[`Document`](#document-1)\>
677
677
 
678
- Defined in: [libraries/epub/src/index.tsx:2715](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2715)
678
+ Defined in: [libraries/epub/src/index.tsx:2768](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2768)
679
679
 
680
680
  Create a new XHTML document with the given body
681
681
  and head.
@@ -696,7 +696,7 @@ and head.
696
696
 
697
697
  > **createXmlDocument**(`root`): [`Document`](#document-1)
698
698
 
699
- Defined in: [libraries/epub/src/index.tsx:2679](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2679)
699
+ Defined in: [libraries/epub/src/index.tsx:2732](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2732)
700
700
 
701
701
  Create a new XML document with the given root node.
702
702
 
@@ -714,7 +714,7 @@ Create a new XML document with the given root node.
714
714
 
715
715
  > **discardAndClose**(): `void`
716
716
 
717
- Defined in: [libraries/epub/src/index.tsx:3266](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3266)
717
+ Defined in: [libraries/epub/src/index.tsx:3323](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3323)
718
718
 
719
719
  ##### Returns
720
720
 
@@ -724,7 +724,7 @@ Defined in: [libraries/epub/src/index.tsx:3266](https://gitlab.com/storyteller-p
724
724
 
725
725
  > **findAllMetadataItems**(`predicate`): `Promise`\<[`MetadataEntry`](#metadataentry)[]\>
726
726
 
727
- Defined in: [libraries/epub/src/index.tsx:743](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L743)
727
+ Defined in: [libraries/epub/src/index.tsx:785](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L785)
728
728
 
729
729
  Returns the item in the metadata element's children array
730
730
  that matches the provided predicate.
@@ -743,7 +743,7 @@ that matches the provided predicate.
743
743
 
744
744
  > **findMetadataItem**(`predicate`): `Promise`\<[`MetadataEntry`](#metadataentry) \| `null`\>
745
745
 
746
- Defined in: [libraries/epub/src/index.tsx:734](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L734)
746
+ Defined in: [libraries/epub/src/index.tsx:776](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L776)
747
747
 
748
748
  Returns the item in the metadata element's children array
749
749
  that matches the provided predicate.
@@ -762,7 +762,7 @@ that matches the provided predicate.
762
762
 
763
763
  > **getBaseDirection**(): `Promise`\<`"auto"` \| `"rtl"` \| `"ltr"`\>
764
764
 
765
- Defined in: [libraries/epub/src/index.tsx:1450](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1450)
765
+ Defined in: [libraries/epub/src/index.tsx:1492](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1492)
766
766
 
767
767
  Retrieve the base direction from the package element.
768
768
 
@@ -781,7 +781,7 @@ https://www.w3.org/TR/epub-33/#attrdef-dir
781
781
 
782
782
  > **getCollections**(): `Promise`\<[`Collection`](#collection)[]\>
783
783
 
784
- Defined in: [libraries/epub/src/index.tsx:1901](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1901)
784
+ Defined in: [libraries/epub/src/index.tsx:1953](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1953)
785
785
 
786
786
  Retrieve the list of collections.
787
787
 
@@ -793,7 +793,7 @@ Retrieve the list of collections.
793
793
 
794
794
  > **getContributors**(): `Promise`\<[`DcCreator`](#dccreator)[]\>
795
795
 
796
- Defined in: [libraries/epub/src/index.tsx:2102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2102)
796
+ Defined in: [libraries/epub/src/index.tsx:2154](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2154)
797
797
 
798
798
  Retrieve the list of contributors.
799
799
 
@@ -812,7 +812,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccontributor
812
812
 
813
813
  > **getCoverImage**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `null`\>
814
814
 
815
- Defined in: [libraries/epub/src/index.tsx:1346](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1346)
815
+ Defined in: [libraries/epub/src/index.tsx:1388](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1388)
816
816
 
817
817
  Retrieve the cover image data as a byte array.
818
818
 
@@ -832,7 +832,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
832
832
 
833
833
  > **getCoverImageItem**(): `Promise`\<[`ManifestItem`](#manifestitem) \| `null`\>
834
834
 
835
- Defined in: [libraries/epub/src/index.tsx:1327](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1327)
835
+ Defined in: [libraries/epub/src/index.tsx:1369](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1369)
836
836
 
837
837
  Retrieve the cover image manifest item.
838
838
 
@@ -853,7 +853,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
853
853
 
854
854
  > **getCreators**(`type`): `Promise`\<[`DcCreator`](#dccreator)[]\>
855
855
 
856
- Defined in: [libraries/epub/src/index.tsx:2038](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2038)
856
+ Defined in: [libraries/epub/src/index.tsx:2090](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2090)
857
857
 
858
858
  Retrieve the list of creators.
859
859
 
@@ -875,7 +875,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
875
875
 
876
876
  > **getDescription**(): `Promise`\<`string` \| `null`\>
877
877
 
878
- Defined in: [libraries/epub/src/index.tsx:1769](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1769)
878
+ Defined in: [libraries/epub/src/index.tsx:1811](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1811)
879
879
 
880
880
  Retrieve the Epub's description as specified in its
881
881
  package document metadata.
@@ -892,7 +892,7 @@ include HTML markup.
892
892
 
893
893
  > **getGuideEntries**(): `Promise`\<[`GuideItem`](#guideitem)[]\>
894
894
 
895
- Defined in: [libraries/epub/src/index.tsx:3249](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3249)
895
+ Defined in: [libraries/epub/src/index.tsx:3306](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3306)
896
896
 
897
897
  Retrieve the guide entries from the package document.
898
898
 
@@ -907,7 +907,7 @@ the landmarks nav, but many publications still include it.
907
907
 
908
908
  > **getIdentifier**(): `Promise`\<`string` \| `null`\>
909
909
 
910
- Defined in: [libraries/epub/src/index.tsx:835](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L835)
910
+ Defined in: [libraries/epub/src/index.tsx:877](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L877)
911
911
 
912
912
  Retrieve the first identifier from the dc:identifier element
913
913
  in the EPUB metadata.
@@ -931,7 +931,7 @@ or [getIdentifiers](#getidentifiers) to get all identifiers.
931
931
 
932
932
  > **getIdentifiers**(): `Promise`\<[`EpubIdentifier`](#epubidentifier)[]\>
933
933
 
934
- Defined in: [libraries/epub/src/index.tsx:1001](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1001)
934
+ Defined in: [libraries/epub/src/index.tsx:1043](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1043)
935
935
 
936
936
  Retrieve every `dc:identifier` entry, returned as found.
937
937
 
@@ -952,7 +952,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
952
952
 
953
953
  > **getItemArchiveLength**(`id`): `Promise`\<`number`\>
954
954
 
955
- Defined in: [libraries/epub/src/index.tsx:515](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L515)
955
+ Defined in: [libraries/epub/src/index.tsx:538](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L538)
956
956
 
957
957
  Length of the underlying archive entry for a manifest item, in bytes
958
958
  Necessary to compute the readium page count which is for COMPRESSED content
@@ -975,7 +975,7 @@ Necessary to compute the readium page count which is for COMPRESSED content
975
975
 
976
976
  > **getLandmarks**(`__namedParameters`): `Promise`\<[`Navigation`](#navigation) \| `null`\>
977
977
 
978
- Defined in: [libraries/epub/src/index.tsx:2501](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2501)
978
+ Defined in: [libraries/epub/src/index.tsx:2555](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2555)
979
979
 
980
980
  Returns the structured landmarks navigation document
981
981
  as a Navigation object
@@ -999,7 +999,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-landmarks
999
999
 
1000
1000
  > **getLanguage**(): `Promise`\<`Locale` \| `null`\>
1001
1001
 
1002
- Defined in: [libraries/epub/src/index.tsx:1606](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1606)
1002
+ Defined in: [libraries/epub/src/index.tsx:1648](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1648)
1003
1003
 
1004
1004
  Retrieve the Epub's language as specified in its
1005
1005
  package document metadata.
@@ -1019,7 +1019,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
1019
1019
 
1020
1020
  > **getLayout**(): `Promise`\<`"pre-paginated"` \| `"reflowable"`\>
1021
1021
 
1022
- Defined in: [libraries/epub/src/index.tsx:1431](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1431)
1022
+ Defined in: [libraries/epub/src/index.tsx:1473](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1473)
1023
1023
 
1024
1024
  Retrieve the layout from the rendition:layout meta element
1025
1025
  in the EPUB metadata.
@@ -1038,12 +1038,14 @@ https://www.w3.org/TR/epub-33/#layout
1038
1038
 
1039
1039
  > **getManifest**(): `Promise`\<`Record`\<`string`, [`ManifestItem`](#manifestitem)\>\>
1040
1040
 
1041
- Defined in: [libraries/epub/src/index.tsx:661](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L661)
1041
+ Defined in: [libraries/epub/src/index.tsx:698](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L698)
1042
1042
 
1043
1043
  Retrieve the manifest for the Epub.
1044
1044
 
1045
1045
  This is represented as a map from each manifest items'
1046
- id to the rest of its properties.
1046
+ id to the rest of its properties. Manifest hrefs are
1047
+ always URI-encoded (e.g. `chapter one.xhtml` -> `chapter%20one.xhtml`),
1048
+ even if the raw XML is (incorrectly) not URI-encoded.
1047
1049
 
1048
1050
  ##### Returns
1049
1051
 
@@ -1057,7 +1059,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
1057
1059
 
1058
1060
  > **getMetadata**(): `Promise`\<[`EpubMetadata`](#epubmetadata)\>
1059
1061
 
1060
- Defined in: [libraries/epub/src/index.tsx:803](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L803)
1062
+ Defined in: [libraries/epub/src/index.tsx:845](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L845)
1061
1063
 
1062
1064
  Retrieve the metadata entries for the Epub.
1063
1065
 
@@ -1079,7 +1081,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1079
1081
 
1080
1082
  > **getModifiedDate**(): `Promise`\<`Date` \| `null`\>
1081
1083
 
1082
- Defined in: [libraries/epub/src/index.tsx:1414](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1414)
1084
+ Defined in: [libraries/epub/src/index.tsx:1456](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1456)
1083
1085
 
1084
1086
  Retrieve the modified date from the dcterms:modified metadata
1085
1087
  in the EPUB metadata as a Date object.
@@ -1098,7 +1100,7 @@ https://www.w3.org/TR/epub-33/#sec-metadata-last-modified
1098
1100
 
1099
1101
  > **getNcxTableOfContents**(): `Promise`\<[`NavigationList`](#navigationlist)\>
1100
1102
 
1101
- Defined in: [libraries/epub/src/index.tsx:3173](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3173)
1103
+ Defined in: [libraries/epub/src/index.tsx:3230](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3230)
1102
1104
 
1103
1105
  Parse the NCX table of contents, if one exists, and return
1104
1106
  a tree of TocEntry nodes.
@@ -1115,7 +1117,7 @@ NCX for backwards compatibility.
1115
1117
 
1116
1118
  > **getPackageDocumentSource**(): `Promise`\<`string`\>
1117
1119
 
1118
- Defined in: [libraries/epub/src/index.tsx:569](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L569)
1120
+ Defined in: [libraries/epub/src/index.tsx:592](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L592)
1119
1121
 
1120
1122
  ##### Returns
1121
1123
 
@@ -1123,9 +1125,15 @@ Defined in: [libraries/epub/src/index.tsx:569](https://gitlab.com/storyteller-pl
1123
1125
 
1124
1126
  #### getPackageElement()
1125
1127
 
1126
- > **getPackageElement**(): `Promise`\<[`Element`](#element-1)\>
1128
+ > **getPackageElement**(`lock`): `Promise`\<[`Element`](#element-1)\>
1127
1129
 
1128
- Defined in: [libraries/epub/src/index.tsx:592](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L592)
1130
+ Defined in: [libraries/epub/src/index.tsx:615](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L615)
1131
+
1132
+ ##### Parameters
1133
+
1134
+ | Parameter | Type | Default value |
1135
+ | --------- | --------- | ------------- |
1136
+ | `lock` | `boolean` | `true` |
1129
1137
 
1130
1138
  ##### Returns
1131
1139
 
@@ -1135,7 +1143,7 @@ Defined in: [libraries/epub/src/index.tsx:592](https://gitlab.com/storyteller-pl
1135
1143
 
1136
1144
  > **getPackageVocabularyPrefixes**(): `Promise`\<`Record`\<`string`, `string`\>\>
1137
1145
 
1138
- Defined in: [libraries/epub/src/index.tsx:1786](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1786)
1146
+ Defined in: [libraries/epub/src/index.tsx:1828](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1828)
1139
1147
 
1140
1148
  Return the set of custom vocabulary prefixes set on this publication's
1141
1149
  root package element.
@@ -1154,7 +1162,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
1154
1162
 
1155
1163
  > **getPageBreakSource**(): `Promise`\<[`EpubSource`](#epubsource) \| `null`\>
1156
1164
 
1157
- Defined in: [libraries/epub/src/index.tsx:1038](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1038)
1165
+ Defined in: [libraries/epub/src/index.tsx:1080](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1080)
1158
1166
 
1159
1167
  Retrieve the `pageBreakSource` property (EPUB 3.4, spec D.2.9), the
1160
1168
  publication-level source for the source of its page break markers.
@@ -1175,7 +1183,7 @@ https://www.w3.org/TR/epub/#pageBreakSource
1175
1183
 
1176
1184
  > **getPageList**(`__namedParameters`): `Promise`\<[`Navigation`](#navigation) \| `null`\>
1177
1185
 
1178
- Defined in: [libraries/epub/src/index.tsx:2513](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2513)
1186
+ Defined in: [libraries/epub/src/index.tsx:2567](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2567)
1179
1187
 
1180
1188
  Returns the structured page list navigation document
1181
1189
  as a Navigation object
@@ -1199,7 +1207,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-landmarks
1199
1207
 
1200
1208
  > **getPublicationDate**(): `Promise`\<`Date` \| `null`\>
1201
1209
 
1202
- Defined in: [libraries/epub/src/index.tsx:1383](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1383)
1210
+ Defined in: [libraries/epub/src/index.tsx:1425](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1425)
1203
1211
 
1204
1212
  Retrieve the publication date from the dc:date element
1205
1213
  in the EPUB metadata as a Date object.
@@ -1218,7 +1226,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
1218
1226
 
1219
1227
  > **getRootfile**(): `Promise`\<`string`\>
1220
1228
 
1221
- Defined in: [libraries/epub/src/index.tsx:526](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L526)
1229
+ Defined in: [libraries/epub/src/index.tsx:549](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L549)
1222
1230
 
1223
1231
  ##### Returns
1224
1232
 
@@ -1228,7 +1236,7 @@ Defined in: [libraries/epub/src/index.tsx:526](https://gitlab.com/storyteller-pl
1228
1236
 
1229
1237
  > **getSources**(): `Promise`\<[`EpubSource`](#epubsource)[]\>
1230
1238
 
1231
- Defined in: [libraries/epub/src/index.tsx:1015](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1015)
1239
+ Defined in: [libraries/epub/src/index.tsx:1057](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1057)
1232
1240
 
1233
1241
  Retrieve every `dc:source` entry, returned as found.
1234
1242
 
@@ -1248,7 +1256,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsource
1248
1256
 
1249
1257
  > **getSpineItems**(): `Promise`\<[`ManifestItem`](#manifestitem) & `object`[]\>
1250
1258
 
1251
- Defined in: [libraries/epub/src/index.tsx:2289](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2289)
1259
+ Defined in: [libraries/epub/src/index.tsx:2343](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2343)
1252
1260
 
1253
1261
  Retrieve the manifest items that make up the Epub's spine.
1254
1262
 
@@ -1267,7 +1275,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1267
1275
 
1268
1276
  > **getSubjects**(): `Promise`\<(`string` \| [`DcSubject`](#dcsubject))[]\>
1269
1277
 
1270
- Defined in: [libraries/epub/src/index.tsx:1561](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1561)
1278
+ Defined in: [libraries/epub/src/index.tsx:1603](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1603)
1271
1279
 
1272
1280
  Retrieve the list of subjects for this EPUB.
1273
1281
 
@@ -1288,7 +1296,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
1288
1296
 
1289
1297
  > **getSubtitle**(): `Promise`\<`string` \| `null`\>
1290
1298
 
1291
- Defined in: [libraries/epub/src/index.tsx:1676](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1676)
1299
+ Defined in: [libraries/epub/src/index.tsx:1718](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1718)
1292
1300
 
1293
1301
  Retrieve the subtitle of the Epub, if it exists.
1294
1302
 
@@ -1304,7 +1312,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1304
1312
 
1305
1313
  > **getTableOfContents**(`__namedParameters`): `Promise`\<[`Navigation`](#navigation) \| `null`\>
1306
1314
 
1307
- Defined in: [libraries/epub/src/index.tsx:2483](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2483)
1315
+ Defined in: [libraries/epub/src/index.tsx:2537](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2537)
1308
1316
 
1309
1317
  Returns the structured table of contents navigation document
1310
1318
  as a Navigation object.
@@ -1328,7 +1336,7 @@ https://www.w3.org/TR/epub-33/#sec-nav-toc
1328
1336
 
1329
1337
  > **getTitle**(`expanded`): `Promise`\<`string` \| `null`\>
1330
1338
 
1331
- Defined in: [libraries/epub/src/index.tsx:1652](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1652)
1339
+ Defined in: [libraries/epub/src/index.tsx:1694](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1694)
1332
1340
 
1333
1341
  Retrieve the title of the Epub.
1334
1342
 
@@ -1350,7 +1358,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1350
1358
 
1351
1359
  > **getTitles**(): `Promise`\<`object`[]\>
1352
1360
 
1353
- Defined in: [libraries/epub/src/index.tsx:1688](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1688)
1361
+ Defined in: [libraries/epub/src/index.tsx:1730](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1730)
1354
1362
 
1355
1363
  Retrieve all title entries of the Epub.
1356
1364
 
@@ -1366,7 +1374,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
1366
1374
 
1367
1375
  > **getType**(): `Promise`\<[`MetadataEntry`](#metadataentry) \| `null`\>
1368
1376
 
1369
- Defined in: [libraries/epub/src/index.tsx:1483](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1483)
1377
+ Defined in: [libraries/epub/src/index.tsx:1525](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1525)
1370
1378
 
1371
1379
  Retrieve the publication type from the dc:type element
1372
1380
  in the EPUB metadata.
@@ -1385,7 +1393,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
1385
1393
 
1386
1394
  > **getUniqueIdentifier**(): `Promise`\<`string` \| `null`\>
1387
1395
 
1388
- Defined in: [libraries/epub/src/index.tsx:867](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L867)
1396
+ Defined in: [libraries/epub/src/index.tsx:909](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L909)
1389
1397
 
1390
1398
  Retrieve the identifier with the unique identifier id
1391
1399
  in the EPUB metadata.
@@ -1404,7 +1412,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1404
1412
 
1405
1413
  > **getUniqueIdentifierId**(): `Promise`\<`string` \| `null`\>
1406
1414
 
1407
- Defined in: [libraries/epub/src/index.tsx:939](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L939)
1415
+ Defined in: [libraries/epub/src/index.tsx:981](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L981)
1408
1416
 
1409
1417
  Retrieve the id of the publication's unique identifier, as declared by the
1410
1418
  package element's `unique-identifier` attribute.
@@ -1421,7 +1429,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1421
1429
 
1422
1430
  > **getVersion**(): `Promise`\<`string`\>
1423
1431
 
1424
- Defined in: [libraries/epub/src/index.tsx:3160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3160)
1432
+ Defined in: [libraries/epub/src/index.tsx:3217](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3217)
1425
1433
 
1426
1434
  Returns the EPUB version declared on the package element.
1427
1435
 
@@ -1435,7 +1443,7 @@ Returns the EPUB version declared on the package element.
1435
1443
 
1436
1444
  > **readFileContents**(`href`, `relativeTo?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1437
1445
 
1438
- Defined in: [libraries/epub/src/index.tsx:2620](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2620)
1446
+ Defined in: [libraries/epub/src/index.tsx:2673](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2673)
1439
1447
 
1440
1448
  Retrieve the contents of a file, given its href.
1441
1449
 
@@ -1457,7 +1465,7 @@ and an encoding parameter.
1457
1465
 
1458
1466
  > **readFileContents**(`href`, `relativeTo`, `encoding`): `Promise`\<`string`\>
1459
1467
 
1460
- Defined in: [libraries/epub/src/index.tsx:2621](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2621)
1468
+ Defined in: [libraries/epub/src/index.tsx:2674](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2674)
1461
1469
 
1462
1470
  Retrieve the contents of a file, given its href.
1463
1471
 
@@ -1482,7 +1490,7 @@ and an encoding parameter.
1482
1490
 
1483
1491
  > **readItemContents**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
1484
1492
 
1485
- Defined in: [libraries/epub/src/index.tsx:2653](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2653)
1493
+ Defined in: [libraries/epub/src/index.tsx:2706](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2706)
1486
1494
 
1487
1495
  Retrieve the contents of a manifest item, given its id.
1488
1496
 
@@ -1504,7 +1512,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1504
1512
 
1505
1513
  > **readItemContents**(`id`, `encoding`): `Promise`\<`string`\>
1506
1514
 
1507
- Defined in: [libraries/epub/src/index.tsx:2654](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2654)
1515
+ Defined in: [libraries/epub/src/index.tsx:2707](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2707)
1508
1516
 
1509
1517
  Retrieve the contents of a manifest item, given its id.
1510
1518
 
@@ -1529,7 +1537,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
1529
1537
 
1530
1538
  > **readXhtmlItemContents**(`id`, `as?`): `Promise`\<[`Document`](#document-1)\>
1531
1539
 
1532
- Defined in: [libraries/epub/src/index.tsx:2765](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2765)
1540
+ Defined in: [libraries/epub/src/index.tsx:2818](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2818)
1533
1541
 
1534
1542
  Retrieves the contents of an XHTML item, given its manifest id.
1535
1543
 
@@ -1552,7 +1560,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1552
1560
 
1553
1561
  > **readXhtmlItemContents**(`id`, `as`): `Promise`\<`string`\>
1554
1562
 
1555
- Defined in: [libraries/epub/src/index.tsx:2766](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2766)
1563
+ Defined in: [libraries/epub/src/index.tsx:2819](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2819)
1556
1564
 
1557
1565
  Retrieves the contents of an XHTML item, given its manifest id.
1558
1566
 
@@ -1575,7 +1583,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
1575
1583
 
1576
1584
  > **removeCollection**(`index`): `Promise`\<`void`\>
1577
1585
 
1578
- Defined in: [libraries/epub/src/index.tsx:2005](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2005)
1586
+ Defined in: [libraries/epub/src/index.tsx:2057](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2057)
1579
1587
 
1580
1588
  Remove a collection from the EPUB metadata.
1581
1589
 
@@ -1596,7 +1604,7 @@ refers to the array returned by `epub.getCollections()`.
1596
1604
 
1597
1605
  > **removeContributor**(`index`): `Promise`\<`void`\>
1598
1606
 
1599
- Defined in: [libraries/epub/src/index.tsx:2234](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2234)
1607
+ Defined in: [libraries/epub/src/index.tsx:2286](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2286)
1600
1608
 
1601
1609
  Remove a contributor from the EPUB metadata.
1602
1610
 
@@ -1624,7 +1632,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1624
1632
 
1625
1633
  > **removeCreator**(`index`, `type`): `Promise`\<`void`\>
1626
1634
 
1627
- Defined in: [libraries/epub/src/index.tsx:2197](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2197)
1635
+ Defined in: [libraries/epub/src/index.tsx:2249](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2249)
1628
1636
 
1629
1637
  Remove a creator from the EPUB metadata.
1630
1638
 
@@ -1650,7 +1658,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1650
1658
 
1651
1659
  > **removeManifestItem**(`id`): `Promise`\<`void`\>
1652
1660
 
1653
- Defined in: [libraries/epub/src/index.tsx:2865](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2865)
1661
+ Defined in: [libraries/epub/src/index.tsx:2918](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2918)
1654
1662
 
1655
1663
  ##### Parameters
1656
1664
 
@@ -1666,7 +1674,7 @@ Defined in: [libraries/epub/src/index.tsx:2865](https://gitlab.com/storyteller-p
1666
1674
 
1667
1675
  > **removeMetadata**(`predicate`): `Promise`\<`void`\>
1668
1676
 
1669
- Defined in: [libraries/epub/src/index.tsx:3135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3135)
1677
+ Defined in: [libraries/epub/src/index.tsx:3192](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3192)
1670
1678
 
1671
1679
  Remove one or more metadata entries.
1672
1680
 
@@ -1692,7 +1700,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1692
1700
 
1693
1701
  > **removeSpineItem**(`index`): `Promise`\<`void`\>
1694
1702
 
1695
- Defined in: [libraries/epub/src/index.tsx:2362](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2362)
1703
+ Defined in: [libraries/epub/src/index.tsx:2416](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2416)
1696
1704
 
1697
1705
  Remove the spine item at the specified index.
1698
1706
 
@@ -1714,7 +1722,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
1714
1722
 
1715
1723
  > **removeSubject**(`index`): `Promise`\<`void`\>
1716
1724
 
1717
- Defined in: [libraries/epub/src/index.tsx:1533](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1533)
1725
+ Defined in: [libraries/epub/src/index.tsx:1575](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1575)
1718
1726
 
1719
1727
  Remove a subject from the EPUB metadata.
1720
1728
 
@@ -1739,7 +1747,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
1739
1747
 
1740
1748
  > **replaceMetadata**(`predicate`, `entry`): `Promise`\<`void`\>
1741
1749
 
1742
- Defined in: [libraries/epub/src/index.tsx:3084](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3084)
1750
+ Defined in: [libraries/epub/src/index.tsx:3141](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3141)
1743
1751
 
1744
1752
  Replace a metadata entry with a new one.
1745
1753
 
@@ -1766,7 +1774,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
1766
1774
 
1767
1775
  > **resolveHref**(`href`, `relativeTo?`, `__namedParameters?`): `Promise`\<`string`\>
1768
1776
 
1769
- Defined in: [libraries/epub/src/index.tsx:2576](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2576)
1777
+ Defined in: [libraries/epub/src/index.tsx:2631](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2631)
1770
1778
 
1771
1779
  Returns a path-relative-scheme-less URL, relative to the
1772
1780
  container root.
@@ -1791,7 +1799,7 @@ a navigation document, is handed back unchanged.
1791
1799
 
1792
1800
  > **saveAndClose**(): `Promise`\<`void`\>
1793
1801
 
1794
- Defined in: [libraries/epub/src/index.tsx:3281](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3281)
1802
+ Defined in: [libraries/epub/src/index.tsx:3338](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3338)
1795
1803
 
1796
1804
  Write the current contents of the Epub to a new
1797
1805
  EPUB archive on disk.
@@ -1808,7 +1816,7 @@ timestamp.
1808
1816
 
1809
1817
  > **setCoverImage**(`href`, `data`): `Promise`\<`void`\>
1810
1818
 
1811
- Defined in: [libraries/epub/src/index.tsx:1360](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1360)
1819
+ Defined in: [libraries/epub/src/index.tsx:1402](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1402)
1812
1820
 
1813
1821
  Set the cover image for the EPUB.
1814
1822
 
@@ -1831,7 +1839,7 @@ the provided href within the publication.
1831
1839
 
1832
1840
  > **setDescription**(`description`): `Promise`\<`void`\>
1833
1841
 
1834
- Defined in: [libraries/epub/src/index.tsx:1753](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1753)
1842
+ Defined in: [libraries/epub/src/index.tsx:1795](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1795)
1835
1843
 
1836
1844
  Update the Epub's description metadata entry.
1837
1845
 
@@ -1853,7 +1861,7 @@ Otherwise creates a new element. Any non-ASCII symbols,
1853
1861
 
1854
1862
  > **setIdentifier**(`identifier`): `Promise`\<`void`\>
1855
1863
 
1856
- Defined in: [libraries/epub/src/index.tsx:851](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L851)
1864
+ Defined in: [libraries/epub/src/index.tsx:893](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L893)
1857
1865
 
1858
1866
  Set the dc:identifier metadata element with the provided string.
1859
1867
 
@@ -1882,7 +1890,7 @@ Use [setUniqueIdentifier](#setuniqueidentifier) instead.
1882
1890
 
1883
1891
  > **setIdentifiers**(`identifiers`): `Promise`\<`void`\>
1884
1892
 
1885
- Defined in: [libraries/epub/src/index.tsx:1107](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1107)
1893
+ Defined in: [libraries/epub/src/index.tsx:1149](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1149)
1886
1894
 
1887
1895
  Replace the publication's `dc:identifier` entries.
1888
1896
 
@@ -1919,7 +1927,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
1919
1927
 
1920
1928
  > **setLanguage**(`locale`): `Promise`\<`void`\>
1921
1929
 
1922
- Defined in: [libraries/epub/src/index.tsx:1635](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1635)
1930
+ Defined in: [libraries/epub/src/index.tsx:1677](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1677)
1923
1931
 
1924
1932
  Update the Epub's language metadata entry.
1925
1933
 
@@ -1944,7 +1952,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
1944
1952
 
1945
1953
  > **setPackageVocabularyPrefix**(`prefix`, `uri`): `Promise`\<`void`\>
1946
1954
 
1947
- Defined in: [libraries/epub/src/index.tsx:1804](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1804)
1955
+ Defined in: [libraries/epub/src/index.tsx:1846](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1846)
1948
1956
 
1949
1957
  Set a custom vocabulary prefix on the root package element.
1950
1958
 
@@ -1967,7 +1975,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
1967
1975
 
1968
1976
  > **setPageBreakSource**(`value`): `Promise`\<`void`\>
1969
1977
 
1970
- Defined in: [libraries/epub/src/index.tsx:1074](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1074)
1978
+ Defined in: [libraries/epub/src/index.tsx:1116](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1116)
1971
1979
 
1972
1980
  Set the `pageBreakSource` property (EPUB 3.4, spec D.2.9), or remove it when
1973
1981
  passed null. Replaces an existing `pageBreakSource` meta if present.
@@ -1992,7 +2000,7 @@ https://www.w3.org/TR/epub/#pageBreakSource
1992
2000
 
1993
2001
  > **setPublicationDate**(`date`): `Promise`\<`void`\>
1994
2002
 
1995
- Defined in: [libraries/epub/src/index.tsx:1398](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1398)
2003
+ Defined in: [libraries/epub/src/index.tsx:1440](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1440)
1996
2004
 
1997
2005
  Set the dc:date metadata element with the provided date.
1998
2006
 
@@ -2017,7 +2025,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
2017
2025
 
2018
2026
  > **setSources**(`sources`): `Promise`\<`void`\>
2019
2027
 
2020
- Defined in: [libraries/epub/src/index.tsx:1212](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1212)
2028
+ Defined in: [libraries/epub/src/index.tsx:1254](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1254)
2021
2029
 
2022
2030
  Replace the publication's `dc:source` entries.
2023
2031
 
@@ -2048,7 +2056,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsource
2048
2056
 
2049
2057
  > **setTitle**(`title`): `Promise`\<`void`\>
2050
2058
 
2051
- Defined in: [libraries/epub/src/index.tsx:1830](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1830)
2059
+ Defined in: [libraries/epub/src/index.tsx:1882](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1882)
2052
2060
 
2053
2061
  Set the title of the Epub.
2054
2062
 
@@ -2075,7 +2083,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
2075
2083
 
2076
2084
  > **setTitles**(`entries`): `Promise`\<`void`\>
2077
2085
 
2078
- Defined in: [libraries/epub/src/index.tsx:1852](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1852)
2086
+ Defined in: [libraries/epub/src/index.tsx:1904](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1904)
2079
2087
 
2080
2088
  ##### Parameters
2081
2089
 
@@ -2091,7 +2099,7 @@ Defined in: [libraries/epub/src/index.tsx:1852](https://gitlab.com/storyteller-p
2091
2099
 
2092
2100
  > **setType**(`type`): `Promise`\<`void`\>
2093
2101
 
2094
- Defined in: [libraries/epub/src/index.tsx:1467](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1467)
2102
+ Defined in: [libraries/epub/src/index.tsx:1509](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L1509)
2095
2103
 
2096
2104
  Set the dc:type metadata element.
2097
2105
 
@@ -2116,7 +2124,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
2116
2124
 
2117
2125
  > **setUniqueIdentifier**(`identifier`): `Promise`\<`void`\>
2118
2126
 
2119
- Defined in: [libraries/epub/src/index.tsx:892](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L892)
2127
+ Defined in: [libraries/epub/src/index.tsx:934](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L934)
2120
2128
 
2121
2129
  Set the unique identifier id for the EPUB.
2122
2130
 
@@ -2143,7 +2151,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
2143
2151
 
2144
2152
  > **updateManifestItem**(`id`, `newItem`): `Promise`\<`void`\>
2145
2153
 
2146
- Defined in: [libraries/epub/src/index.tsx:3001](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3001)
2154
+ Defined in: [libraries/epub/src/index.tsx:3059](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3059)
2147
2155
 
2148
2156
  Update the manifest entry for an existing item.
2149
2157
 
@@ -2169,14 +2177,15 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
2169
2177
 
2170
2178
  > **withPackage**(`producer`): `Promise`\<`void`\>
2171
2179
 
2172
- Defined in: [libraries/epub/src/index.tsx:621](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L621)
2180
+ Defined in: [libraries/epub/src/index.tsx:655](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L655)
2173
2181
 
2174
2182
  Safely modify the package document, without race conditions.
2175
2183
 
2176
2184
  Since the reading the package document is an async process,
2177
2185
  multiple simultaneously dispatched function calls that all
2178
2186
  attempt to modify it can clobber each other's changes. This
2179
- method uses a mutex to ensure that each update runs exclusively.
2187
+ method uses a read/write lock to ensure that each update runs
2188
+ exclusively.
2180
2189
 
2181
2190
  ##### Parameters
2182
2191
 
@@ -2194,7 +2203,7 @@ method uses a mutex to ensure that each update runs exclusively.
2194
2203
 
2195
2204
  > **writeItemContents**(`id`, `contents`): `Promise`\<`void`\>
2196
2205
 
2197
- Defined in: [libraries/epub/src/index.tsx:2821](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2821)
2206
+ Defined in: [libraries/epub/src/index.tsx:2874](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2874)
2198
2207
 
2199
2208
  Write new contents for an existing manifest item,
2200
2209
  specified by its id.
@@ -2221,7 +2230,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
2221
2230
 
2222
2231
  > **writeItemContents**(`id`, `contents`, `encoding`): `Promise`\<`void`\>
2223
2232
 
2224
- Defined in: [libraries/epub/src/index.tsx:2822](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2822)
2233
+ Defined in: [libraries/epub/src/index.tsx:2875](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2875)
2225
2234
 
2226
2235
  Write new contents for an existing manifest item,
2227
2236
  specified by its id.
@@ -2249,7 +2258,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
2249
2258
 
2250
2259
  > **writeXhtmlItemContents**(`id`, `contents`): `Promise`\<`void`\>
2251
2260
 
2252
- Defined in: [libraries/epub/src/index.tsx:2861](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2861)
2261
+ Defined in: [libraries/epub/src/index.tsx:2914](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L2914)
2253
2262
 
2254
2263
  Write new contents for an existing XHTML item,
2255
2264
  specified by its id.
@@ -2276,7 +2285,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
2276
2285
 
2277
2286
  > `static` **assertEpub3**(`epub`): `Promise`\<`void`\>
2278
2287
 
2279
- Defined in: [libraries/epub/src/index.tsx:479](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L479)
2288
+ Defined in: [libraries/epub/src/index.tsx:502](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L502)
2280
2289
 
2281
2290
  ##### Parameters
2282
2291
 
@@ -2292,7 +2301,7 @@ Defined in: [libraries/epub/src/index.tsx:479](https://gitlab.com/storyteller-pl
2292
2301
 
2293
2302
  > `static` **create**(`path`, `dublinCore`, `additionalMetadata`): `Promise`\<[`Epub`](#epub)\>
2294
2303
 
2295
- Defined in: [libraries/epub/src/index.tsx:427](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L427)
2304
+ Defined in: [libraries/epub/src/index.tsx:450](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L450)
2296
2305
 
2297
2306
  Construct a new EPUB on a writable backend, optionally seeded
2298
2307
  with the provided metadata. Equivalent to
@@ -2314,7 +2323,7 @@ with the provided metadata. Equivalent to
2314
2323
 
2315
2324
  > `static` **formatSmilDuration**(`duration`): `string`
2316
2325
 
2317
- Defined in: [libraries/epub/src/index.tsx:358](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L358)
2326
+ Defined in: [libraries/epub/src/index.tsx:381](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L381)
2318
2327
 
2319
2328
  Format a duration, provided as a number of seconds, as
2320
2329
  a SMIL clock value, to be used for Media Overlays.
@@ -2339,7 +2348,7 @@ https://www.w3.org/TR/epub-33/#sec-duration
2339
2348
 
2340
2349
  > `static` **from**(`pathOrData`): `Promise`\<[`Epub`](#epub)\>
2341
2350
 
2342
- Defined in: [libraries/epub/src/index.tsx:463](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L463)
2351
+ Defined in: [libraries/epub/src/index.tsx:486](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L486)
2343
2352
 
2344
2353
  Open an existing EPUB publication, extracting it to a temp directory
2345
2354
  so writes can mutate the unpacked tree and rezip with `saveAndClose`.
@@ -2367,7 +2376,7 @@ when the archive is not a valid EPUB 3
2367
2376
 
2368
2377
  > `static` **from**(`pathOrData`, `options`): `Promise`\<[`EpubReader`](#epubreader)\>
2369
2378
 
2370
- Defined in: [libraries/epub/src/index.tsx:464](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L464)
2379
+ Defined in: [libraries/epub/src/index.tsx:487](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L487)
2371
2380
 
2372
2381
  Open an existing EPUB publication, extracting it to a temp directory
2373
2382
  so writes can mutate the unpacked tree and rezip with `saveAndClose`.
@@ -2396,7 +2405,7 @@ when the archive is not a valid EPUB 3
2396
2405
 
2397
2406
  > `static` **from**(`pathOrData`, `options?`): `Promise`\<[`Epub`](#epub) \| [`EpubReader`](#epubreader)\>
2398
2407
 
2399
- Defined in: [libraries/epub/src/index.tsx:468](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L468)
2408
+ Defined in: [libraries/epub/src/index.tsx:491](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L491)
2400
2409
 
2401
2410
  Open an existing EPUB publication, extracting it to a temp directory
2402
2411
  so writes can mutate the unpacked tree and rezip with `saveAndClose`.
@@ -2425,7 +2434,7 @@ when the archive is not a valid EPUB 3
2425
2434
 
2426
2435
  > `static` **upgrade**(`path`, `options`): `Promise`\<[`Epub`](#epub)\>
2427
2436
 
2428
- Defined in: [libraries/epub/src/index.tsx:3309](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3309)
2437
+ Defined in: [libraries/epub/src/index.tsx:3366](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3366)
2429
2438
 
2430
2439
  Upgrade an EPUB 2 publication to EPUB 3 in place, returning a new,
2431
2440
  valid Epub 3 instance. Equivalent to
@@ -2446,7 +2455,7 @@ valid Epub 3 instance. Equivalent to
2446
2455
 
2447
2456
  > `static` **using**\<`A`\>(`adapterClass`): [`EpubFactory`](#epubfactory)\<`A`\>
2448
2457
 
2449
- Defined in: [libraries/epub/src/index.tsx:447](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L447)
2458
+ Defined in: [libraries/epub/src/index.tsx:470](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L470)
2450
2459
 
2451
2460
  Specify the storage backend to use for the EPUB
2452
2461
 
@@ -2480,7 +2489,7 @@ using reader = await Epub.using(MemoryAdapter).from(buffer, { cache: false });
2480
2489
 
2481
2490
  ## EpubFactory\<A\>
2482
2491
 
2483
- Defined in: [libraries/epub/src/index.tsx:3338](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3338)
2492
+ Defined in: [libraries/epub/src/index.tsx:3395](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3395)
2484
2493
 
2485
2494
  Adapter-bound factory returned by [Epub.using](#using).
2486
2495
 
@@ -2501,7 +2510,7 @@ gracefully when the adapter doesn't support the operation: `create` and
2501
2510
 
2502
2511
  > **new EpubFactory**\<`A`\>(`adapterClass`): [`EpubFactory`](#epubfactory)\<`A`\>
2503
2512
 
2504
- Defined in: [libraries/epub/src/index.tsx:3339](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3339)
2513
+ Defined in: [libraries/epub/src/index.tsx:3396](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3396)
2505
2514
 
2506
2515
  ##### Parameters
2507
2516
 
@@ -2519,7 +2528,7 @@ Defined in: [libraries/epub/src/index.tsx:3339](https://gitlab.com/storyteller-p
2519
2528
 
2520
2529
  > `readonly` **adapterClass**: `A`
2521
2530
 
2522
- Defined in: [libraries/epub/src/index.tsx:3339](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3339)
2531
+ Defined in: [libraries/epub/src/index.tsx:3396](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3396)
2523
2532
 
2524
2533
  ### Methods
2525
2534
 
@@ -2527,7 +2536,7 @@ Defined in: [libraries/epub/src/index.tsx:3339](https://gitlab.com/storyteller-p
2527
2536
 
2528
2537
  > **create**(`path`, `__namedParameters`, `additionalMetadata`): `Promise`\<[`EpubInstanceFor`](#epubinstancefor)\<`A`\>\>
2529
2538
 
2530
- Defined in: [libraries/epub/src/index.tsx:3419](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3419)
2539
+ Defined in: [libraries/epub/src/index.tsx:3476](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3476)
2531
2540
 
2532
2541
  Construct a new EPUB on this factory's adapter, optionally seeded
2533
2542
  with the provided metadata. Requires a writable adapter that
@@ -2555,7 +2564,7 @@ when the adapter is read-only or does not implement initEmpty
2555
2564
 
2556
2565
  > **from**(`source`, `options`): `Promise`\<`Pick`\<[`Epub`](#epub), `"storage"` \| `"getItemArchiveLength"` \| `"getRootfile"` \| `"getPackageDocumentSource"` \| `"getPackageElement"` \| `"getManifest"` \| `"findMetadataItem"` \| `"findAllMetadataItems"` \| `"getMetadata"` \| `"getIdentifier"` \| `"getUniqueIdentifier"` \| `"getUniqueIdentifierId"` \| `"getIdentifiers"` \| `"getSources"` \| `"getPageBreakSource"` \| `"getCoverImageItem"` \| `"getCoverImage"` \| `"getPublicationDate"` \| `"getModifiedDate"` \| `"getLayout"` \| `"getBaseDirection"` \| `"getType"` \| `"getSubjects"` \| `"getLanguage"` \| `"getTitle"` \| `"getSubtitle"` \| `"getTitles"` \| `"getDescription"` \| `"getPackageVocabularyPrefixes"` \| `"getCollections"` \| `"getCreators"` \| `"getContributors"` \| `"getSpineItems"` \| `"getTableOfContents"` \| `"getLandmarks"` \| `"getPageList"` \| `"resolveHref"` \| `"readFileContents"` \| `"readItemContents"` \| `"readXhtmlItemContents"` \| `"getVersion"` \| `"getNcxTableOfContents"` \| `"getGuideEntries"` \| `"discardAndClose"`\> & `Disposable` & `object`\>
2557
2566
 
2558
- Defined in: [libraries/epub/src/index.tsx:3346](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3346)
2567
+ Defined in: [libraries/epub/src/index.tsx:3403](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3403)
2559
2568
 
2560
2569
  Open an existing EPUB through this factory's adapter
2561
2570
 
@@ -2578,7 +2587,7 @@ when the archive is not a valid EPUB 3
2578
2587
 
2579
2588
  > **from**(`source`, `options?`): `Promise`\<[`EpubInstanceFor`](#epubinstancefor)\<`A`\> & `object`\>
2580
2589
 
2581
- Defined in: [libraries/epub/src/index.tsx:3350](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3350)
2590
+ Defined in: [libraries/epub/src/index.tsx:3407](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3407)
2582
2591
 
2583
2592
  Open an existing EPUB through this factory's adapter
2584
2593
 
@@ -2601,7 +2610,7 @@ when the archive is not a valid EPUB 3
2601
2610
 
2602
2611
  > **readPackageDocumentSource**(`source`, `options`): `Promise`\<`string`\>
2603
2612
 
2604
- Defined in: [libraries/epub/src/index.tsx:3393](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3393)
2613
+ Defined in: [libraries/epub/src/index.tsx:3450](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3450)
2605
2614
 
2606
2615
  ##### Parameters
2607
2616
 
@@ -2618,7 +2627,7 @@ Defined in: [libraries/epub/src/index.tsx:3393](https://gitlab.com/storyteller-p
2618
2627
 
2619
2628
  > **upgrade**(`path`, `options`): `Promise`\<[`EpubInstanceFor`](#epubinstancefor)\<`A`\>\>
2620
2629
 
2621
- Defined in: [libraries/epub/src/index.tsx:3546](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3546)
2630
+ Defined in: [libraries/epub/src/index.tsx:3603](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3603)
2622
2631
 
2623
2632
  Upgrade an EPUB 2 publication to EPUB 3 in place using this
2624
2633
  factory's adapter, returning a new, valid Epub 3 instance.
@@ -2656,7 +2665,7 @@ when the adapter is read-only
2656
2665
 
2657
2666
  ## EpubReadOnlyError
2658
2667
 
2659
- Defined in: [libraries/epub/src/index.tsx:243](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L243)
2668
+ Defined in: [libraries/epub/src/index.tsx:255](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L255)
2660
2669
 
2661
2670
  ### Extends
2662
2671
 
@@ -2885,7 +2894,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
2885
2894
 
2886
2895
  ## EpubVersionError
2887
2896
 
2888
- Defined in: [libraries/epub/src/index.tsx:242](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L242)
2897
+ Defined in: [libraries/epub/src/index.tsx:254](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L254)
2889
2898
 
2890
2899
  ### Extends
2891
2900
 
@@ -3560,7 +3569,7 @@ Defined in: [libraries/epub/src/adapters/tmpfs.ts:79](https://gitlab.com/storyte
3560
3569
 
3561
3570
  ## AlternateScript
3562
3571
 
3563
- Defined in: [libraries/epub/src/index.tsx:159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L159)
3572
+ Defined in: [libraries/epub/src/index.tsx:171](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L171)
3564
3573
 
3565
3574
  ### Properties
3566
3575
 
@@ -3568,13 +3577,13 @@ Defined in: [libraries/epub/src/index.tsx:159](https://gitlab.com/storyteller-pl
3568
3577
 
3569
3578
  > **locale**: `Locale`
3570
3579
 
3571
- Defined in: [libraries/epub/src/index.tsx:161](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L161)
3580
+ Defined in: [libraries/epub/src/index.tsx:173](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L173)
3572
3581
 
3573
3582
  #### name
3574
3583
 
3575
3584
  > **name**: `string`
3576
3585
 
3577
- Defined in: [libraries/epub/src/index.tsx:160](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L160)
3586
+ Defined in: [libraries/epub/src/index.tsx:172](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L172)
3578
3587
 
3579
3588
  ---
3580
3589
 
@@ -4501,7 +4510,7 @@ Defined in: node_modules/@xmldom/xmldom/index.d.ts:588
4501
4510
 
4502
4511
  ## Collection
4503
4512
 
4504
- Defined in: [libraries/epub/src/index.tsx:183](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L183)
4513
+ Defined in: [libraries/epub/src/index.tsx:195](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L195)
4505
4514
 
4506
4515
  ### Properties
4507
4516
 
@@ -4509,25 +4518,25 @@ Defined in: [libraries/epub/src/index.tsx:183](https://gitlab.com/storyteller-pl
4509
4518
 
4510
4519
  > **name**: `string`
4511
4520
 
4512
- Defined in: [libraries/epub/src/index.tsx:184](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L184)
4521
+ Defined in: [libraries/epub/src/index.tsx:196](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L196)
4513
4522
 
4514
4523
  #### position?
4515
4524
 
4516
4525
  > `optional` **position**: `string`
4517
4526
 
4518
- Defined in: [libraries/epub/src/index.tsx:186](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L186)
4527
+ Defined in: [libraries/epub/src/index.tsx:198](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L198)
4519
4528
 
4520
4529
  #### type?
4521
4530
 
4522
4531
  > `optional` **type**: `string`
4523
4532
 
4524
- Defined in: [libraries/epub/src/index.tsx:185](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L185)
4533
+ Defined in: [libraries/epub/src/index.tsx:197](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L197)
4525
4534
 
4526
4535
  ---
4527
4536
 
4528
4537
  ## DcCreator
4529
4538
 
4530
- Defined in: [libraries/epub/src/index.tsx:164](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L164)
4539
+ Defined in: [libraries/epub/src/index.tsx:176](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L176)
4531
4540
 
4532
4541
  ### Properties
4533
4542
 
@@ -4535,37 +4544,37 @@ Defined in: [libraries/epub/src/index.tsx:164](https://gitlab.com/storyteller-pl
4535
4544
 
4536
4545
  > `optional` **alternateScripts**: [`AlternateScript`](#alternatescript)[]
4537
4546
 
4538
- Defined in: [libraries/epub/src/index.tsx:169](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L169)
4547
+ Defined in: [libraries/epub/src/index.tsx:181](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L181)
4539
4548
 
4540
4549
  #### fileAs?
4541
4550
 
4542
4551
  > `optional` **fileAs**: `string`
4543
4552
 
4544
- Defined in: [libraries/epub/src/index.tsx:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L168)
4553
+ Defined in: [libraries/epub/src/index.tsx:180](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L180)
4545
4554
 
4546
4555
  #### name
4547
4556
 
4548
4557
  > **name**: `string`
4549
4558
 
4550
- Defined in: [libraries/epub/src/index.tsx:165](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L165)
4559
+ Defined in: [libraries/epub/src/index.tsx:177](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L177)
4551
4560
 
4552
4561
  #### role?
4553
4562
 
4554
4563
  > `optional` **role**: `string`
4555
4564
 
4556
- Defined in: [libraries/epub/src/index.tsx:166](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L166)
4565
+ Defined in: [libraries/epub/src/index.tsx:178](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L178)
4557
4566
 
4558
4567
  #### roleScheme?
4559
4568
 
4560
4569
  > `optional` **roleScheme**: `string`
4561
4570
 
4562
- Defined in: [libraries/epub/src/index.tsx:167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L167)
4571
+ Defined in: [libraries/epub/src/index.tsx:179](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L179)
4563
4572
 
4564
4573
  ---
4565
4574
 
4566
4575
  ## DcSubject
4567
4576
 
4568
- Defined in: [libraries/epub/src/index.tsx:126](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L126)
4577
+ Defined in: [libraries/epub/src/index.tsx:138](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L138)
4569
4578
 
4570
4579
  ### Properties
4571
4580
 
@@ -4573,19 +4582,19 @@ Defined in: [libraries/epub/src/index.tsx:126](https://gitlab.com/storyteller-pl
4573
4582
 
4574
4583
  > **authority**: `string`
4575
4584
 
4576
- Defined in: [libraries/epub/src/index.tsx:128](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L128)
4585
+ Defined in: [libraries/epub/src/index.tsx:140](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L140)
4577
4586
 
4578
4587
  #### term
4579
4588
 
4580
4589
  > **term**: `string`
4581
4590
 
4582
- Defined in: [libraries/epub/src/index.tsx:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L129)
4591
+ Defined in: [libraries/epub/src/index.tsx:141](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L141)
4583
4592
 
4584
4593
  #### value
4585
4594
 
4586
4595
  > **value**: `string`
4587
4596
 
4588
- Defined in: [libraries/epub/src/index.tsx:127](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L127)
4597
+ Defined in: [libraries/epub/src/index.tsx:139](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L139)
4589
4598
 
4590
4599
  ---
4591
4600
 
@@ -6881,7 +6890,7 @@ Defined in: node_modules/@xmldom/xmldom/index.d.ts:588
6881
6890
 
6882
6891
  ## DublinCore
6883
6892
 
6884
- Defined in: [libraries/epub/src/index.tsx:172](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L172)
6893
+ Defined in: [libraries/epub/src/index.tsx:184](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L184)
6885
6894
 
6886
6895
  ### Properties
6887
6896
 
@@ -6889,49 +6898,49 @@ Defined in: [libraries/epub/src/index.tsx:172](https://gitlab.com/storyteller-pl
6889
6898
 
6890
6899
  > `optional` **contributors**: [`DcCreator`](#dccreator)[]
6891
6900
 
6892
- Defined in: [libraries/epub/src/index.tsx:179](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L179)
6901
+ Defined in: [libraries/epub/src/index.tsx:191](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L191)
6893
6902
 
6894
6903
  #### creators?
6895
6904
 
6896
6905
  > `optional` **creators**: [`DcCreator`](#dccreator)[]
6897
6906
 
6898
- Defined in: [libraries/epub/src/index.tsx:178](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L178)
6907
+ Defined in: [libraries/epub/src/index.tsx:190](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L190)
6899
6908
 
6900
6909
  #### date?
6901
6910
 
6902
6911
  > `optional` **date**: `Date`
6903
6912
 
6904
- Defined in: [libraries/epub/src/index.tsx:176](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L176)
6913
+ Defined in: [libraries/epub/src/index.tsx:188](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L188)
6905
6914
 
6906
6915
  #### identifier
6907
6916
 
6908
6917
  > **identifier**: `string`
6909
6918
 
6910
- Defined in: [libraries/epub/src/index.tsx:175](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L175)
6919
+ Defined in: [libraries/epub/src/index.tsx:187](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L187)
6911
6920
 
6912
6921
  #### language
6913
6922
 
6914
6923
  > **language**: `Locale`
6915
6924
 
6916
- Defined in: [libraries/epub/src/index.tsx:174](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L174)
6925
+ Defined in: [libraries/epub/src/index.tsx:186](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L186)
6917
6926
 
6918
6927
  #### subjects?
6919
6928
 
6920
6929
  > `optional` **subjects**: (`string` \| [`DcSubject`](#dcsubject))[]
6921
6930
 
6922
- Defined in: [libraries/epub/src/index.tsx:177](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L177)
6931
+ Defined in: [libraries/epub/src/index.tsx:189](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L189)
6923
6932
 
6924
6933
  #### title
6925
6934
 
6926
6935
  > **title**: `string`
6927
6936
 
6928
- Defined in: [libraries/epub/src/index.tsx:173](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L173)
6937
+ Defined in: [libraries/epub/src/index.tsx:185](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L185)
6929
6938
 
6930
6939
  #### type?
6931
6940
 
6932
6941
  > `optional` **type**: `string`
6933
6942
 
6934
- Defined in: [libraries/epub/src/index.tsx:180](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L180)
6943
+ Defined in: [libraries/epub/src/index.tsx:192](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L192)
6935
6944
 
6936
6945
  ---
6937
6946
 
@@ -7977,4 +7986,2741 @@ Checks whether the DOM implementation implements a specific feature and its vers
7977
7986
  | Parameter | Type | Description |
7978
7987
  | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
7979
7988
  | `feature` | `string` | The package name of the feature to test. This is the same name that can be passed to the method `hasFeature` on `DOMImplementation`. |
7980
- | `version` | `string` | Thi
7989
+ | `version` | `string` | This is the version number of the package name to test. |
7990
+
7991
+ ##### Returns
7992
+
7993
+ `true`
7994
+
7995
+ ##### Deprecated
7996
+
7997
+ Since `DOMImplementation.hasFeature` is deprecated and always returns true.
7998
+
7999
+ ##### Since
8000
+
8001
+ Introduced in DOM Level 2
8002
+
8003
+ ##### See
8004
+
8005
+ DOMImplementation.hasFeature
8006
+
8007
+ ##### Inherited from
8008
+
8009
+ `Node.isSupported`
8010
+
8011
+ #### lookupNamespaceURI()
8012
+
8013
+ > **lookupNamespaceURI**(`prefix`): `string` \| `null`
8014
+
8015
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:571
8016
+
8017
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)
8018
+
8019
+ ##### Parameters
8020
+
8021
+ | Parameter | Type |
8022
+ | --------- | ------------------ |
8023
+ | `prefix` | `string` \| `null` |
8024
+
8025
+ ##### Returns
8026
+
8027
+ `string` \| `null`
8028
+
8029
+ ##### Inherited from
8030
+
8031
+ `Node.lookupNamespaceURI`
8032
+
8033
+ #### lookupPrefix()
8034
+
8035
+ > **lookupPrefix**(`namespace`): `string` \| `null`
8036
+
8037
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:574
8038
+
8039
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)
8040
+
8041
+ ##### Parameters
8042
+
8043
+ | Parameter | Type |
8044
+ | ----------- | ------------------ |
8045
+ | `namespace` | `string` \| `null` |
8046
+
8047
+ ##### Returns
8048
+
8049
+ `string` \| `null`
8050
+
8051
+ ##### Inherited from
8052
+
8053
+ `Node.lookupPrefix`
8054
+
8055
+ #### normalize()
8056
+
8057
+ > **normalize**(): `void`
8058
+
8059
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:582
8060
+
8061
+ Removes empty exclusive Text nodes and concatenates the data of remaining contiguous
8062
+ exclusive Text nodes into the first of their nodes.
8063
+
8064
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)
8065
+
8066
+ ##### Returns
8067
+
8068
+ `void`
8069
+
8070
+ ##### Inherited from
8071
+
8072
+ `Node.normalize`
8073
+
8074
+ #### removeAttribute()
8075
+
8076
+ > **removeAttribute**(`qualifiedName`): `void`
8077
+
8078
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:969
8079
+
8080
+ Removes element's first attribute whose qualified name is qualifiedName.
8081
+
8082
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)
8083
+
8084
+ ##### Parameters
8085
+
8086
+ | Parameter | Type |
8087
+ | --------------- | -------- |
8088
+ | `qualifiedName` | `string` |
8089
+
8090
+ ##### Returns
8091
+
8092
+ `void`
8093
+
8094
+ #### removeAttributeNode()
8095
+
8096
+ > **removeAttributeNode**(`attr`): [`Attr`](#attr-1)
8097
+
8098
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:977
8099
+
8100
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)
8101
+
8102
+ ##### Parameters
8103
+
8104
+ | Parameter | Type |
8105
+ | --------- | ----------------- |
8106
+ | `attr` | [`Attr`](#attr-1) |
8107
+
8108
+ ##### Returns
8109
+
8110
+ [`Attr`](#attr-1)
8111
+
8112
+ #### removeAttributeNS()
8113
+
8114
+ > **removeAttributeNS**(`namespace`, `localName`): `void`
8115
+
8116
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:975
8117
+
8118
+ Removes element's attribute whose namespace is namespace and local name is localName.
8119
+
8120
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)
8121
+
8122
+ ##### Parameters
8123
+
8124
+ | Parameter | Type |
8125
+ | ----------- | ------------------ |
8126
+ | `namespace` | `string` \| `null` |
8127
+ | `localName` | `string` |
8128
+
8129
+ ##### Returns
8130
+
8131
+ `void`
8132
+
8133
+ #### removeChild()
8134
+
8135
+ > **removeChild**(`child`): [`Node`](#node-1)
8136
+
8137
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:585
8138
+
8139
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)
8140
+
8141
+ ##### Parameters
8142
+
8143
+ | Parameter | Type |
8144
+ | --------- | ----------------- |
8145
+ | `child` | [`Node`](#node-1) |
8146
+
8147
+ ##### Returns
8148
+
8149
+ [`Node`](#node-1)
8150
+
8151
+ ##### Inherited from
8152
+
8153
+ `Node.removeChild`
8154
+
8155
+ #### replaceChild()
8156
+
8157
+ > **replaceChild**(`node`, `child`): [`Node`](#node-1)
8158
+
8159
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:588
8160
+
8161
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)
8162
+
8163
+ ##### Parameters
8164
+
8165
+ | Parameter | Type |
8166
+ | --------- | ----------------- |
8167
+ | `node` | [`Node`](#node-1) |
8168
+ | `child` | [`Node`](#node-1) |
8169
+
8170
+ ##### Returns
8171
+
8172
+ [`Node`](#node-1)
8173
+
8174
+ ##### Inherited from
8175
+
8176
+ `Node.replaceChild`
8177
+
8178
+ #### setAttribute()
8179
+
8180
+ > **setAttribute**(`qualifiedName`, `value`): `void`
8181
+
8182
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:983
8183
+
8184
+ Sets the value of element's first attribute whose qualified name is qualifiedName to value.
8185
+
8186
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)
8187
+
8188
+ ##### Parameters
8189
+
8190
+ | Parameter | Type |
8191
+ | --------------- | -------- |
8192
+ | `qualifiedName` | `string` |
8193
+ | `value` | `string` |
8194
+
8195
+ ##### Returns
8196
+
8197
+ `void`
8198
+
8199
+ #### setAttributeNode()
8200
+
8201
+ > **setAttributeNode**(`attr`): [`Attr`](#attr-1) \| `null`
8202
+
8203
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:996
8204
+
8205
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)
8206
+
8207
+ ##### Parameters
8208
+
8209
+ | Parameter | Type |
8210
+ | --------- | ----------------- |
8211
+ | `attr` | [`Attr`](#attr-1) |
8212
+
8213
+ ##### Returns
8214
+
8215
+ [`Attr`](#attr-1) \| `null`
8216
+
8217
+ #### setAttributeNodeNS()
8218
+
8219
+ > **setAttributeNodeNS**(`attr`): [`Attr`](#attr-1) \| `null`
8220
+
8221
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:998
8222
+
8223
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)
8224
+
8225
+ ##### Parameters
8226
+
8227
+ | Parameter | Type |
8228
+ | --------- | ----------------- |
8229
+ | `attr` | [`Attr`](#attr-1) |
8230
+
8231
+ ##### Returns
8232
+
8233
+ [`Attr`](#attr-1) \| `null`
8234
+
8235
+ #### setAttributeNS()
8236
+
8237
+ > **setAttributeNS**(`namespace`, `qualifiedName`, `value`): `void`
8238
+
8239
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:990
8240
+
8241
+ Sets the value of element's attribute whose namespace is namespace and local name is
8242
+ localName to value.
8243
+
8244
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)
8245
+
8246
+ ##### Parameters
8247
+
8248
+ | Parameter | Type |
8249
+ | --------------- | ------------------ |
8250
+ | `namespace` | `string` \| `null` |
8251
+ | `qualifiedName` | `string` |
8252
+ | `value` | `string` |
8253
+
8254
+ ##### Returns
8255
+
8256
+ `void`
8257
+
8258
+ ---
8259
+
8260
+ ## Epub2UpgradeOptions
8261
+
8262
+ Defined in: [libraries/epub/src/upgrade.tsx:76](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/upgrade.tsx#L76)
8263
+
8264
+ ### Properties
8265
+
8266
+ #### outputPath?
8267
+
8268
+ > `optional` **outputPath**: `string`
8269
+
8270
+ Defined in: [libraries/epub/src/upgrade.tsx:80](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/upgrade.tsx#L80)
8271
+
8272
+ The path to the output file. If provided, the input file will be copied to the output path.
8273
+
8274
+ #### removeNcx?
8275
+
8276
+ > `optional` **removeNcx**: `boolean`
8277
+
8278
+ Defined in: [libraries/epub/src/upgrade.tsx:84](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/upgrade.tsx#L84)
8279
+
8280
+ Whether to remove the NCX file, as it's technically optional in EPUB 3.
8281
+
8282
+ ---
8283
+
8284
+ ## EpubIdentifier
8285
+
8286
+ Defined in: [libraries/epub/src/index.tsx:144](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L144)
8287
+
8288
+ ### Properties
8289
+
8290
+ #### id?
8291
+
8292
+ > `optional` **id**: `string`
8293
+
8294
+ Defined in: [libraries/epub/src/index.tsx:146](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L146)
8295
+
8296
+ #### identifierType?
8297
+
8298
+ > `optional` **identifierType**: `string`
8299
+
8300
+ Defined in: [libraries/epub/src/index.tsx:148](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L148)
8301
+
8302
+ the value of a refining `identifier-type` meta, if present
8303
+
8304
+ #### scheme?
8305
+
8306
+ > `optional` **scheme**: `string`
8307
+
8308
+ Defined in: [libraries/epub/src/index.tsx:150](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L150)
8309
+
8310
+ the `scheme` of a refining `identifier-type` meta, or a legacy `opf:scheme` attribute
8311
+
8312
+ #### value
8313
+
8314
+ > **value**: `string`
8315
+
8316
+ Defined in: [libraries/epub/src/index.tsx:145](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L145)
8317
+
8318
+ ---
8319
+
8320
+ ## EpubListEntry
8321
+
8322
+ Defined in: [libraries/epub/src/adapters/interface.ts:39](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L39)
8323
+
8324
+ ### Properties
8325
+
8326
+ #### absolutePath
8327
+
8328
+ > **absolutePath**: `string`
8329
+
8330
+ Defined in: [libraries/epub/src/adapters/interface.ts:41](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L41)
8331
+
8332
+ location the adapter can read the entry back from, in whatever form it stores
8333
+
8334
+ #### relativePath
8335
+
8336
+ > **relativePath**: `string`
8337
+
8338
+ Defined in: [libraries/epub/src/adapters/interface.ts:43](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L43)
8339
+
8340
+ the entry name, as it appears in the archive
8341
+
8342
+ ---
8343
+
8344
+ ## EpubSource
8345
+
8346
+ Defined in: [libraries/epub/src/index.tsx:153](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L153)
8347
+
8348
+ ### Properties
8349
+
8350
+ #### id?
8351
+
8352
+ > `optional` **id**: `string`
8353
+
8354
+ Defined in: [libraries/epub/src/index.tsx:155](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L155)
8355
+
8356
+ #### identifierType?
8357
+
8358
+ > `optional` **identifierType**: `string`
8359
+
8360
+ Defined in: [libraries/epub/src/index.tsx:157](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L157)
8361
+
8362
+ the value of a refining `identifier-type` meta, if present
8363
+
8364
+ #### isPageBreakSource?
8365
+
8366
+ > `optional` **isPageBreakSource**: `boolean`
8367
+
8368
+ Defined in: [libraries/epub/src/index.tsx:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L168)
8369
+
8370
+ whether this source has a `source-of="pagination"` refinement
8371
+ or of a `<meta property="pageBreakSource">` element
8372
+
8373
+ as of EPUB 3.4 `source-of` is advised-deprecated in favour of the
8374
+ publication-level `pageBreakSource` property. if you want to
8375
+ be sure to get the source of pagination, use [Epub.getPageBreakSource](#getpagebreaksource)
8376
+
8377
+ #### scheme?
8378
+
8379
+ > `optional` **scheme**: `string`
8380
+
8381
+ Defined in: [libraries/epub/src/index.tsx:159](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L159)
8382
+
8383
+ the `scheme` of a refining `identifier-type` meta, or a legacy `opf:scheme` attribute
8384
+
8385
+ #### value
8386
+
8387
+ > **value**: `string`
8388
+
8389
+ Defined in: [libraries/epub/src/index.tsx:154](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L154)
8390
+
8391
+ ---
8392
+
8393
+ ## EpubStorageAdapter
8394
+
8395
+ Defined in: [libraries/epub/src/adapters/interface.ts:56](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L56)
8396
+
8397
+ Adapters only receive entry names, which is:
8398
+
8399
+ - the name a file has in the archive itself
8400
+ - relative to the container root, slash-separated,
8401
+ - already percent-decoded (eg `OEBPS/a b.xhtml`, not `OEBPS/a%20b.xhtml`)
8402
+
8403
+ Adapter decides where to store files under what name
8404
+ In previous versions of the EPUB lib, this was a little bit more muddled, leading to
8405
+ eg the TmpFsAdapter trying to read `OEBPS/a%20b.xhtml`, whereas it was stored as `OEBPS/a b.xhtml`
8406
+
8407
+ ### Methods
8408
+
8409
+ #### archiveLength()
8410
+
8411
+ > **archiveLength**(`entry`): `Promise`\<`number`\>
8412
+
8413
+ Defined in: [libraries/epub/src/adapters/interface.ts:71](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L71)
8414
+
8415
+ Length of an entry in bytes, for the readium page-count heuristic
8416
+ which expects compressed size when available
8417
+
8418
+ ##### Parameters
8419
+
8420
+ | Parameter | Type |
8421
+ | --------- | -------- |
8422
+ | `entry` | `string` |
8423
+
8424
+ ##### Returns
8425
+
8426
+ `Promise`\<`number`\>
8427
+
8428
+ #### dispose()
8429
+
8430
+ > **dispose**(): `void` \| `Promise`\<`void`\>
8431
+
8432
+ Defined in: [libraries/epub/src/adapters/interface.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L90)
8433
+
8434
+ Always called on close or error
8435
+
8436
+ ##### Returns
8437
+
8438
+ `void` \| `Promise`\<`void`\>
8439
+
8440
+ #### duplicate()?
8441
+
8442
+ > `optional` **duplicate**(): `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
8443
+
8444
+ Defined in: [libraries/epub/src/adapters/interface.ts:84](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L84)
8445
+
8446
+ Required for Epub.copy
8447
+
8448
+ ##### Returns
8449
+
8450
+ `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
8451
+
8452
+ #### exists()
8453
+
8454
+ > **exists**(`entry`): `Promise`\<`boolean`\>
8455
+
8456
+ Defined in: [libraries/epub/src/adapters/interface.ts:65](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L65)
8457
+
8458
+ Whether the archive holds an entry under exactly this name.
8459
+ Used to choose between different canditates for an href
8460
+ so should be exact
8461
+
8462
+ ##### Parameters
8463
+
8464
+ | Parameter | Type |
8465
+ | --------- | -------- |
8466
+ | `entry` | `string` |
8467
+
8468
+ ##### Returns
8469
+
8470
+ `Promise`\<`boolean`\>
8471
+
8472
+ #### list()?
8473
+
8474
+ > `optional` **list**(): `AsyncIterable`\<[`EpubListEntry`](#epublistentry)\>
8475
+
8476
+ Defined in: [libraries/epub/src/adapters/interface.ts:81](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L81)
8477
+
8478
+ Required for Epub.saveAndClose to walk the contents
8479
+
8480
+ ##### Returns
8481
+
8482
+ `AsyncIterable`\<[`EpubListEntry`](#epublistentry)\>
8483
+
8484
+ #### read()
8485
+
8486
+ ##### Call Signature
8487
+
8488
+ > **read**(`entry`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
8489
+
8490
+ Defined in: [libraries/epub/src/adapters/interface.ts:57](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L57)
8491
+
8492
+ ###### Parameters
8493
+
8494
+ | Parameter | Type |
8495
+ | --------- | -------- |
8496
+ | `entry` | `string` |
8497
+
8498
+ ###### Returns
8499
+
8500
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
8501
+
8502
+ ##### Call Signature
8503
+
8504
+ > **read**(`entry`, `encoding`): `Promise`\<`string`\>
8505
+
8506
+ Defined in: [libraries/epub/src/adapters/interface.ts:58](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L58)
8507
+
8508
+ ###### Parameters
8509
+
8510
+ | Parameter | Type |
8511
+ | ---------- | --------- |
8512
+ | `entry` | `string` |
8513
+ | `encoding` | `"utf-8"` |
8514
+
8515
+ ###### Returns
8516
+
8517
+ `Promise`\<`string`\>
8518
+
8519
+ #### remove()?
8520
+
8521
+ > `optional` **remove**(`entry`): `Promise`\<`void`\>
8522
+
8523
+ Defined in: [libraries/epub/src/adapters/interface.ts:78](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L78)
8524
+
8525
+ Required for removeManifestItem / setCoverImage replacement
8526
+
8527
+ ##### Parameters
8528
+
8529
+ | Parameter | Type |
8530
+ | --------- | -------- |
8531
+ | `entry` | `string` |
8532
+
8533
+ ##### Returns
8534
+
8535
+ `Promise`\<`void`\>
8536
+
8537
+ #### serialize()?
8538
+
8539
+ > `optional` **serialize**(`targetPath`): `Promise`\<`void`\>
8540
+
8541
+ Defined in: [libraries/epub/src/adapters/interface.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L87)
8542
+
8543
+ Required for Epub.saveAndClose
8544
+
8545
+ ##### Parameters
8546
+
8547
+ | Parameter | Type |
8548
+ | ------------ | -------- |
8549
+ | `targetPath` | `string` |
8550
+
8551
+ ##### Returns
8552
+
8553
+ `Promise`\<`void`\>
8554
+
8555
+ #### write()?
8556
+
8557
+ ##### Call Signature
8558
+
8559
+ > `optional` **write**(`entry`, `data`): `Promise`\<`void`\>
8560
+
8561
+ Defined in: [libraries/epub/src/adapters/interface.ts:74](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L74)
8562
+
8563
+ Required for any mutation method on Epub
8564
+
8565
+ ###### Parameters
8566
+
8567
+ | Parameter | Type |
8568
+ | --------- | ------------ |
8569
+ | `entry` | `string` |
8570
+ | `data` | `Uint8Array` |
8571
+
8572
+ ###### Returns
8573
+
8574
+ `Promise`\<`void`\>
8575
+
8576
+ ##### Call Signature
8577
+
8578
+ > `optional` **write**(`entry`, `data`, `encoding`): `Promise`\<`void`\>
8579
+
8580
+ Defined in: [libraries/epub/src/adapters/interface.ts:75](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L75)
8581
+
8582
+ ###### Parameters
8583
+
8584
+ | Parameter | Type |
8585
+ | ---------- | --------- |
8586
+ | `entry` | `string` |
8587
+ | `data` | `string` |
8588
+ | `encoding` | `"utf-8"` |
8589
+
8590
+ ###### Returns
8591
+
8592
+ `Promise`\<`void`\>
8593
+
8594
+ ---
8595
+
8596
+ ## EpubStorageAdapterClass\<Opts\>
8597
+
8598
+ Defined in: [libraries/epub/src/adapters/interface.ts:93](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L93)
8599
+
8600
+ ### Type Parameters
8601
+
8602
+ | Type Parameter | Default type |
8603
+ | ------------------------- | ------------ |
8604
+ | `Opts` _extends_ `object` | `object` |
8605
+
8606
+ ### Properties
8607
+
8608
+ #### capabilities
8609
+
8610
+ > `readonly` **capabilities**: [`EpubStorageCapabilities`](#epubstoragecapabilities)
8611
+
8612
+ Defined in: [libraries/epub/src/adapters/interface.ts:95](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L95)
8613
+
8614
+ #### kind
8615
+
8616
+ > `readonly` **kind**: [`EpubStorageKind`](#epubstoragekind)
8617
+
8618
+ Defined in: [libraries/epub/src/adapters/interface.ts:94](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L94)
8619
+
8620
+ ### Methods
8621
+
8622
+ #### init()
8623
+
8624
+ > **init**(`source`, `opts?`): `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
8625
+
8626
+ Defined in: [libraries/epub/src/adapters/interface.ts:101](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L101)
8627
+
8628
+ Open an archive from a path or buffer.
8629
+ Will throw if the archive is not a valid EPUB 3
8630
+
8631
+ ##### Parameters
8632
+
8633
+ | Parameter | Type |
8634
+ | --------- | --------------------------------- |
8635
+ | `source` | [`ArchiveSource`](#archivesource) |
8636
+ | `opts?` | `Opts` |
8637
+
8638
+ ##### Returns
8639
+
8640
+ `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
8641
+
8642
+ #### initEmpty()?
8643
+
8644
+ > `optional` **initEmpty**(`opts?`): `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
8645
+
8646
+ Defined in: [libraries/epub/src/adapters/interface.ts:107](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L107)
8647
+
8648
+ Initialize an empty extract root for [Epub.create](#create).
8649
+ Only necessary for adapters that can write
8650
+
8651
+ ##### Parameters
8652
+
8653
+ | Parameter | Type |
8654
+ | --------- | ------ |
8655
+ | `opts?` | `Opts` |
8656
+
8657
+ ##### Returns
8658
+
8659
+ `Promise`\<[`EpubStorageAdapter`](#epubstorageadapter)\>
8660
+
8661
+ ---
8662
+
8663
+ ## EpubStorageCapabilities
8664
+
8665
+ Defined in: [libraries/epub/src/adapters/interface.ts:34](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L34)
8666
+
8667
+ ### Properties
8668
+
8669
+ #### writable
8670
+
8671
+ > `readonly` **writable**: `boolean`
8672
+
8673
+ Defined in: [libraries/epub/src/adapters/interface.ts:36](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L36)
8674
+
8675
+ when false, the Epub class refuses every mutation method at runtime
8676
+
8677
+ ---
8678
+
8679
+ ## FromOptions
8680
+
8681
+ Defined in: [libraries/epub/src/index.tsx:222](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L222)
8682
+
8683
+ ### Properties
8684
+
8685
+ #### readonly?
8686
+
8687
+ > `optional` **readonly**: `boolean`
8688
+
8689
+ Defined in: [libraries/epub/src/index.tsx:227](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L227)
8690
+
8691
+ when true, mutation methods throw [EpubReadOnlyError](#epubreadonlyerror) at runtime
8692
+
8693
+ ##### Default
8694
+
8695
+ ```ts
8696
+ false;
8697
+ ```
8698
+
8699
+ ---
8700
+
8701
+ ## GuideItem
8702
+
8703
+ Defined in: [libraries/epub/src/index.tsx:216](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L216)
8704
+
8705
+ ### Properties
8706
+
8707
+ #### href
8708
+
8709
+ > **href**: `string`
8710
+
8711
+ Defined in: [libraries/epub/src/index.tsx:217](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L217)
8712
+
8713
+ #### title
8714
+
8715
+ > **title**: `string`
8716
+
8717
+ Defined in: [libraries/epub/src/index.tsx:218](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L218)
8718
+
8719
+ #### type
8720
+
8721
+ > **type**: `string`
8722
+
8723
+ Defined in: [libraries/epub/src/index.tsx:219](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L219)
8724
+
8725
+ ---
8726
+
8727
+ ## Landmark
8728
+
8729
+ Defined in: [libraries/epub/src/upgrade.tsx:70](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/upgrade.tsx#L70)
8730
+
8731
+ ### Properties
8732
+
8733
+ #### href
8734
+
8735
+ > **href**: `string`
8736
+
8737
+ Defined in: [libraries/epub/src/upgrade.tsx:71](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/upgrade.tsx#L71)
8738
+
8739
+ #### title
8740
+
8741
+ > **title**: `string`
8742
+
8743
+ Defined in: [libraries/epub/src/upgrade.tsx:72](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/upgrade.tsx#L72)
8744
+
8745
+ #### type
8746
+
8747
+ > **type**: `string`
8748
+
8749
+ Defined in: [libraries/epub/src/upgrade.tsx:73](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/upgrade.tsx#L73)
8750
+
8751
+ ---
8752
+
8753
+ ## MemoryAdapterOptions
8754
+
8755
+ Defined in: [libraries/epub/src/adapters/memory.ts:13](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/memory.ts#L13)
8756
+
8757
+ ### Properties
8758
+
8759
+ #### cache?
8760
+
8761
+ > `optional` **cache**: `boolean`
8762
+
8763
+ Defined in: [libraries/epub/src/adapters/memory.ts:20](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/memory.ts#L20)
8764
+
8765
+ per-entry decompressed buffer cache
8766
+ turn it off when opening many EPUBs and reading each entry at most once
8767
+ keeps resident size bounded by the entry index, not the decompressed payload sum
8768
+
8769
+ ##### Default
8770
+
8771
+ ```ts
8772
+ true;
8773
+ ```
8774
+
8775
+ #### signal?
8776
+
8777
+ > `optional` **signal**: `AbortSignal`
8778
+
8779
+ Defined in: [libraries/epub/src/adapters/memory.ts:21](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/memory.ts#L21)
8780
+
8781
+ ---
8782
+
8783
+ ## Navigation
8784
+
8785
+ Defined in: [libraries/epub/src/index.tsx:210](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L210)
8786
+
8787
+ ### Properties
8788
+
8789
+ #### children
8790
+
8791
+ > **children**: [`NavigationList`](#navigationlist)
8792
+
8793
+ Defined in: [libraries/epub/src/index.tsx:213](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L213)
8794
+
8795
+ #### role
8796
+
8797
+ > **role**: `string`
8798
+
8799
+ Defined in: [libraries/epub/src/index.tsx:212](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L212)
8800
+
8801
+ #### title?
8802
+
8803
+ > `optional` **title**: `string`
8804
+
8805
+ Defined in: [libraries/epub/src/index.tsx:211](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L211)
8806
+
8807
+ ---
8808
+
8809
+ ## NavigationItem
8810
+
8811
+ Defined in: [libraries/epub/src/index.tsx:201](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L201)
8812
+
8813
+ ### Properties
8814
+
8815
+ #### children?
8816
+
8817
+ > `optional` **children**: [`NavigationList`](#navigationlist)
8818
+
8819
+ Defined in: [libraries/epub/src/index.tsx:205](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L205)
8820
+
8821
+ #### href?
8822
+
8823
+ > `optional` **href**: `string`
8824
+
8825
+ Defined in: [libraries/epub/src/index.tsx:203](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L203)
8826
+
8827
+ #### role?
8828
+
8829
+ > `optional` **role**: `string`
8830
+
8831
+ Defined in: [libraries/epub/src/index.tsx:204](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L204)
8832
+
8833
+ #### title
8834
+
8835
+ > **title**: `string`
8836
+
8837
+ Defined in: [libraries/epub/src/index.tsx:202](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L202)
8838
+
8839
+ ---
8840
+
8841
+ ## Node
8842
+
8843
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:368
8844
+
8845
+ The DOM Node interface is an abstract base class upon which many other DOM API objects are
8846
+ based, thus letting those object types to be used similarly and often interchangeably. As an
8847
+ abstract class, there is no such thing as a plain Node object. All objects that implement
8848
+ Node functionality are based on one of its subclasses. Most notable are Document, Element,
8849
+ and DocumentFragment.
8850
+
8851
+ In addition, every kind of DOM node is represented by an interface based on Node. These
8852
+ include Attr, CharacterData (which Text, Comment, CDATASection and ProcessingInstruction are
8853
+ all based on), and DocumentType.
8854
+
8855
+ In some cases, a particular feature of the base Node interface may not apply to one of its
8856
+ child interfaces; in that case, the inheriting node may return null or throw an exception,
8857
+ depending on circumstances. For example, attempting to add children to a node type that
8858
+ cannot have children will throw an exception.
8859
+
8860
+ **This behavior is slightly different from the in the specs**:
8861
+
8862
+ - unimplemented interfaces: EventTarget
8863
+
8864
+ ### See
8865
+
8866
+ - http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1950641247
8867
+ - https://dom.spec.whatwg.org/#node
8868
+
8869
+ ### Prettierignore
8870
+
8871
+ ### Properties
8872
+
8873
+ #### ATTRIBUTE_NODE
8874
+
8875
+ > `readonly` **ATTRIBUTE_NODE**: `2`
8876
+
8877
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:592
8878
+
8879
+ #### baseURI
8880
+
8881
+ > `readonly` **baseURI**: `"about:blank"`
8882
+
8883
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:396
8884
+
8885
+ Always returns `about:blank` currently.
8886
+
8887
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/baseURI)
8888
+
8889
+ #### CDATA_SECTION_NODE
8890
+
8891
+ > `readonly` **CDATA_SECTION_NODE**: `4`
8892
+
8893
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:596
8894
+
8895
+ node is a CDATASection node.
8896
+
8897
+ #### childNodes
8898
+
8899
+ > `readonly` **childNodes**: `NodeList`
8900
+
8901
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:374
8902
+
8903
+ Returns the children.
8904
+
8905
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)
8906
+
8907
+ #### columnNumber?
8908
+
8909
+ > `optional` **columnNumber**: `number`
8910
+
8911
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:479
8912
+
8913
+ One based column position inside the parsed source,
8914
+ if the `locator` was not disabled.
8915
+
8916
+ #### COMMENT_NODE
8917
+
8918
+ > `readonly` **COMMENT_NODE**: `8`
8919
+
8920
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:602
8921
+
8922
+ node is a Comment node.
8923
+
8924
+ #### DOCUMENT_FRAGMENT_NODE
8925
+
8926
+ > `readonly` **DOCUMENT_FRAGMENT_NODE**: `11`
8927
+
8928
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:608
8929
+
8930
+ node is a DocumentFragment node.
8931
+
8932
+ #### DOCUMENT_NODE
8933
+
8934
+ > `readonly` **DOCUMENT_NODE**: `9`
8935
+
8936
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:604
8937
+
8938
+ node is a document.
8939
+
8940
+ #### DOCUMENT_POSITION_CONTAINED_BY
8941
+
8942
+ > `readonly` **DOCUMENT_POSITION_CONTAINED_BY**: `16`
8943
+
8944
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:619
8945
+
8946
+ Set when other is a descendant of node.
8947
+
8948
+ #### DOCUMENT_POSITION_CONTAINS
8949
+
8950
+ > `readonly` **DOCUMENT_POSITION_CONTAINS**: `8`
8951
+
8952
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:617
8953
+
8954
+ Set when other is an ancestor of node.
8955
+
8956
+ #### DOCUMENT_POSITION_DISCONNECTED
8957
+
8958
+ > `readonly` **DOCUMENT_POSITION_DISCONNECTED**: `1`
8959
+
8960
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:611
8961
+
8962
+ Set when node and other are not in the same tree.
8963
+
8964
+ #### DOCUMENT_POSITION_FOLLOWING
8965
+
8966
+ > `readonly` **DOCUMENT_POSITION_FOLLOWING**: `4`
8967
+
8968
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:615
8969
+
8970
+ Set when other is following node.
8971
+
8972
+ #### DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
8973
+
8974
+ > `readonly` **DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC**: `32`
8975
+
8976
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:620
8977
+
8978
+ #### DOCUMENT_POSITION_PRECEDING
8979
+
8980
+ > `readonly` **DOCUMENT_POSITION_PRECEDING**: `2`
8981
+
8982
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:613
8983
+
8984
+ Set when other is preceding node.
8985
+
8986
+ #### DOCUMENT_TYPE_NODE
8987
+
8988
+ > `readonly` **DOCUMENT_TYPE_NODE**: `10`
8989
+
8990
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:606
8991
+
8992
+ node is a doctype.
8993
+
8994
+ #### ELEMENT_NODE
8995
+
8996
+ > `readonly` **ELEMENT_NODE**: `1`
8997
+
8998
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:591
8999
+
9000
+ node is an element.
9001
+
9002
+ #### ENTITY_NODE
9003
+
9004
+ > `readonly` **ENTITY_NODE**: `6`
9005
+
9006
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:598
9007
+
9008
+ #### ENTITY_REFERENCE_NODE
9009
+
9010
+ > `readonly` **ENTITY_REFERENCE_NODE**: `5`
9011
+
9012
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:597
9013
+
9014
+ #### firstChild
9015
+
9016
+ > `readonly` **firstChild**: [`Node`](#node-1) \| `null`
9017
+
9018
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:380
9019
+
9020
+ Returns the first child.
9021
+
9022
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)
9023
+
9024
+ #### isConnected
9025
+
9026
+ > `readonly` **isConnected**: `boolean`
9027
+
9028
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:402
9029
+
9030
+ Returns true if this node is inside of a document or is the document node itself.
9031
+
9032
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected)
9033
+
9034
+ #### lastChild
9035
+
9036
+ > `readonly` **lastChild**: [`Node`](#node-1) \| `null`
9037
+
9038
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:386
9039
+
9040
+ Returns the last child.
9041
+
9042
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)
9043
+
9044
+ #### lineNumber?
9045
+
9046
+ > `optional` **lineNumber**: `number`
9047
+
9048
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:474
9049
+
9050
+ Zero based line position inside the parsed source,
9051
+ if the `locator` was not disabled.
9052
+
9053
+ #### localName
9054
+
9055
+ > **localName**: `string` \| `null`
9056
+
9057
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:390
9058
+
9059
+ The local part of the qualified name of this node.
9060
+
9061
+ #### namespaceURI
9062
+
9063
+ > `readonly` **namespaceURI**: `string` \| `null`
9064
+
9065
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:406
9066
+
9067
+ The namespace URI of this node.
9068
+
9069
+ #### nextSibling
9070
+
9071
+ > `readonly` **nextSibling**: [`Node`](#node-1) \| `null`
9072
+
9073
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:412
9074
+
9075
+ Returns the next sibling.
9076
+
9077
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)
9078
+
9079
+ #### nodeName
9080
+
9081
+ > `readonly` **nodeName**: `string`
9082
+
9083
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:418
9084
+
9085
+ Returns a string appropriate for the type of node.
9086
+
9087
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)
9088
+
9089
+ #### nodeType
9090
+
9091
+ > `readonly` **nodeType**: `number`
9092
+
9093
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:424
9094
+
9095
+ Returns the type of node.
9096
+
9097
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)
9098
+
9099
+ #### nodeValue
9100
+
9101
+ > **nodeValue**: `string` \| `null`
9102
+
9103
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:426
9104
+
9105
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)
9106
+
9107
+ #### NOTATION_NODE
9108
+
9109
+ > `readonly` **NOTATION_NODE**: `12`
9110
+
9111
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:609
9112
+
9113
+ #### ownerDocument
9114
+
9115
+ > `readonly` **ownerDocument**: [`Document`](#document-1) \| `null`
9116
+
9117
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:432
9118
+
9119
+ Returns the node document. Returns null for documents.
9120
+
9121
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)
9122
+
9123
+ #### parentElement
9124
+
9125
+ > `readonly` **parentElement**: [`Element`](#element-1) \| `null`
9126
+
9127
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:444
9128
+
9129
+ Returns the parent `Node` if it is of type `Element`, otherwise `null`.
9130
+
9131
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)
9132
+
9133
+ #### parentNode
9134
+
9135
+ > `readonly` **parentNode**: [`Node`](#node-1) \| `null`
9136
+
9137
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:438
9138
+
9139
+ Returns the parent.
9140
+
9141
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)
9142
+
9143
+ #### prefix
9144
+
9145
+ > **prefix**: `string` \| `null`
9146
+
9147
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:448
9148
+
9149
+ The prefix of the namespace for this node.
9150
+
9151
+ #### previousSibling
9152
+
9153
+ > `readonly` **previousSibling**: [`Node`](#node-1) \| `null`
9154
+
9155
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:454
9156
+
9157
+ Returns the previous sibling.
9158
+
9159
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)
9160
+
9161
+ #### PROCESSING_INSTRUCTION_NODE
9162
+
9163
+ > `readonly` **PROCESSING_INSTRUCTION_NODE**: `7`
9164
+
9165
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:600
9166
+
9167
+ node is a ProcessingInstruction node.
9168
+
9169
+ #### TEXT_NODE
9170
+
9171
+ > `readonly` **TEXT_NODE**: `3`
9172
+
9173
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:594
9174
+
9175
+ node is a Text node.
9176
+
9177
+ #### textContent
9178
+
9179
+ > **textContent**: `string` \| `null`
9180
+
9181
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:468
9182
+
9183
+ The text content of this node and its descendants.
9184
+
9185
+ For [Element](#element-1) and DocumentFragment nodes, returns the concatenation of the
9186
+ `nodeValue` of every descendant text node, excluding processing instruction and comment
9187
+ nodes. For all other node types, returns `nodeValue`.
9188
+
9189
+ Setting `textContent` on an element or document fragment replaces all child nodes with a
9190
+ single text node; on other nodes it sets `data`, `value`, and `nodeValue` directly.
9191
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/textContent)
9192
+
9193
+ ##### See
9194
+
9195
+ [https://dom.spec.whatwg.org/#dom-node-textcontent](https://dom.spec.whatwg.org/#dom-node-textcontent)
9196
+
9197
+ ### Methods
9198
+
9199
+ #### appendChild()
9200
+
9201
+ > **appendChild**(`node`): [`Node`](#node-1)
9202
+
9203
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:482
9204
+
9205
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)
9206
+
9207
+ ##### Parameters
9208
+
9209
+ | Parameter | Type |
9210
+ | --------- | ----------------- |
9211
+ | `node` | [`Node`](#node-1) |
9212
+
9213
+ ##### Returns
9214
+
9215
+ [`Node`](#node-1)
9216
+
9217
+ #### cloneNode()
9218
+
9219
+ > **cloneNode**(`deep?`): [`Node`](#node-1)
9220
+
9221
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:533
9222
+
9223
+ Returns a copy of node. If deep is true, the copy also includes the node's descendants.
9224
+
9225
+ ##### Parameters
9226
+
9227
+ | Parameter | Type |
9228
+ | --------- | --------- |
9229
+ | `deep?` | `boolean` |
9230
+
9231
+ ##### Returns
9232
+
9233
+ [`Node`](#node-1)
9234
+
9235
+ ##### Throws
9236
+
9237
+ May throw a DOMException if operations within [Element#setAttributeNode](#setattributenode) or
9238
+ [Node#appendChild](#appendchild-8) (which are potentially invoked in this method) do not meet their
9239
+ specific constraints.
9240
+
9241
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)
9242
+
9243
+ #### compareDocumentPosition()
9244
+
9245
+ > **compareDocumentPosition**(`other`): `number`
9246
+
9247
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:540
9248
+
9249
+ Returns a bitmask indicating the position of other relative to node.
9250
+
9251
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)
9252
+
9253
+ ##### Parameters
9254
+
9255
+ | Parameter | Type |
9256
+ | --------- | ----------------- |
9257
+ | `other` | [`Node`](#node-1) |
9258
+
9259
+ ##### Returns
9260
+
9261
+ `number`
9262
+
9263
+ #### contains()
9264
+
9265
+ > **contains**(`other`): `boolean`
9266
+
9267
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:489
9268
+
9269
+ Checks whether `other` is an inclusive descendant of this node.
9270
+
9271
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/contains)
9272
+
9273
+ ##### Parameters
9274
+
9275
+ | Parameter | Type |
9276
+ | --------- | ------------------------------------------ |
9277
+ | `other` | [`Node`](#node-1) \| `null` \| `undefined` |
9278
+
9279
+ ##### Returns
9280
+
9281
+ `boolean`
9282
+
9283
+ #### getRootNode()
9284
+
9285
+ > **getRootNode**(`options`): [`Node`](#node-1)
9286
+
9287
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:502
9288
+
9289
+ Searches for the root node of this node.
9290
+
9291
+ **This behavior is slightly different from the one in the specs**:
9292
+
9293
+ - ignores `options.composed`, since `ShadowRoot`s are unsupported, therefore always
9294
+ returning root.
9295
+
9296
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/getRootNode)
9297
+
9298
+ ##### Parameters
9299
+
9300
+ | Parameter | Type |
9301
+ | --------- | -------------------- |
9302
+ | `options` | `GetRootNodeOptions` |
9303
+
9304
+ ##### Returns
9305
+
9306
+ [`Node`](#node-1)
9307
+
9308
+ ##### See
9309
+
9310
+ - https://dom.spec.whatwg.org/#dom-node-getrootnode
9311
+ - https://dom.spec.whatwg.org/#concept-shadow-including-root
9312
+
9313
+ #### hasChildNodes()
9314
+
9315
+ > **hasChildNodes**(): `boolean`
9316
+
9317
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:547
9318
+
9319
+ Returns whether node has children.
9320
+
9321
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)
9322
+
9323
+ ##### Returns
9324
+
9325
+ `boolean`
9326
+
9327
+ #### insertBefore()
9328
+
9329
+ > **insertBefore**(`node`, `child`): [`Node`](#node-1)
9330
+
9331
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:550
9332
+
9333
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)
9334
+
9335
+ ##### Parameters
9336
+
9337
+ | Parameter | Type |
9338
+ | --------- | --------------------------- |
9339
+ | `node` | [`Node`](#node-1) |
9340
+ | `child` | [`Node`](#node-1) \| `null` |
9341
+
9342
+ ##### Returns
9343
+
9344
+ [`Node`](#node-1)
9345
+
9346
+ #### isDefaultNamespace()
9347
+
9348
+ > **isDefaultNamespace**(`namespace`): `boolean`
9349
+
9350
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:553
9351
+
9352
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)
9353
+
9354
+ ##### Parameters
9355
+
9356
+ | Parameter | Type |
9357
+ | ----------- | ------------------ |
9358
+ | `namespace` | `string` \| `null` |
9359
+
9360
+ ##### Returns
9361
+
9362
+ `boolean`
9363
+
9364
+ #### isEqualNode()
9365
+
9366
+ > **isEqualNode**(`other`): `boolean`
9367
+
9368
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:514
9369
+
9370
+ Checks whether the given node is equal to this node.
9371
+
9372
+ Two nodes are equal when they have the same type, defining characteristics (for the type),
9373
+ and the same `childNodes`. The comparison is iterative to avoid stack overflows on deeply
9374
+ nested trees. `Attribute` nodes of each `Element` pair are also compared iteratively.
9375
+
9376
+ ##### Parameters
9377
+
9378
+ | Parameter | Type |
9379
+ | --------- | ----------------- |
9380
+ | `other` | [`Node`](#node-1) |
9381
+
9382
+ ##### Returns
9383
+
9384
+ `boolean`
9385
+
9386
+ ##### See
9387
+
9388
+ - [https://dom.spec.whatwg.org/#concept-node-equals](https://dom.spec.whatwg.org/#concept-node-equals)
9389
+ - [https://developer.mozilla.org/en-US/docs/Web/API/Node/isEqualNode](https://developer.mozilla.org/en-US/docs/Web/API/Node/isEqualNode)
9390
+
9391
+ #### isSameNode()
9392
+
9393
+ > **isSameNode**(`other`): `boolean`
9394
+
9395
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:521
9396
+
9397
+ Checks whether the given node is this node.
9398
+
9399
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/isSameNode)
9400
+
9401
+ ##### Parameters
9402
+
9403
+ | Parameter | Type |
9404
+ | --------- | ----------------- |
9405
+ | `other` | [`Node`](#node-1) |
9406
+
9407
+ ##### Returns
9408
+
9409
+ `boolean`
9410
+
9411
+ #### ~~isSupported()~~
9412
+
9413
+ > **isSupported**(`feature`, `version`): `true`
9414
+
9415
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:568
9416
+
9417
+ Checks whether the DOM implementation implements a specific feature and its version.
9418
+
9419
+ ##### Parameters
9420
+
9421
+ | Parameter | Type | Description |
9422
+ | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
9423
+ | `feature` | `string` | The package name of the feature to test. This is the same name that can be passed to the method `hasFeature` on `DOMImplementation`. |
9424
+ | `version` | `string` | This is the version number of the package name to test. |
9425
+
9426
+ ##### Returns
9427
+
9428
+ `true`
9429
+
9430
+ ##### Deprecated
9431
+
9432
+ Since `DOMImplementation.hasFeature` is deprecated and always returns true.
9433
+
9434
+ ##### Since
9435
+
9436
+ Introduced in DOM Level 2
9437
+
9438
+ ##### See
9439
+
9440
+ DOMImplementation.hasFeature
9441
+
9442
+ #### lookupNamespaceURI()
9443
+
9444
+ > **lookupNamespaceURI**(`prefix`): `string` \| `null`
9445
+
9446
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:571
9447
+
9448
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)
9449
+
9450
+ ##### Parameters
9451
+
9452
+ | Parameter | Type |
9453
+ | --------- | ------------------ |
9454
+ | `prefix` | `string` \| `null` |
9455
+
9456
+ ##### Returns
9457
+
9458
+ `string` \| `null`
9459
+
9460
+ #### lookupPrefix()
9461
+
9462
+ > **lookupPrefix**(`namespace`): `string` \| `null`
9463
+
9464
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:574
9465
+
9466
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)
9467
+
9468
+ ##### Parameters
9469
+
9470
+ | Parameter | Type |
9471
+ | ----------- | ------------------ |
9472
+ | `namespace` | `string` \| `null` |
9473
+
9474
+ ##### Returns
9475
+
9476
+ `string` \| `null`
9477
+
9478
+ #### normalize()
9479
+
9480
+ > **normalize**(): `void`
9481
+
9482
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:582
9483
+
9484
+ Removes empty exclusive Text nodes and concatenates the data of remaining contiguous
9485
+ exclusive Text nodes into the first of their nodes.
9486
+
9487
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)
9488
+
9489
+ ##### Returns
9490
+
9491
+ `void`
9492
+
9493
+ #### removeChild()
9494
+
9495
+ > **removeChild**(`child`): [`Node`](#node-1)
9496
+
9497
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:585
9498
+
9499
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)
9500
+
9501
+ ##### Parameters
9502
+
9503
+ | Parameter | Type |
9504
+ | --------- | ----------------- |
9505
+ | `child` | [`Node`](#node-1) |
9506
+
9507
+ ##### Returns
9508
+
9509
+ [`Node`](#node-1)
9510
+
9511
+ #### replaceChild()
9512
+
9513
+ > **replaceChild**(`node`, `child`): [`Node`](#node-1)
9514
+
9515
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:588
9516
+
9517
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)
9518
+
9519
+ ##### Parameters
9520
+
9521
+ | Parameter | Type |
9522
+ | --------- | ----------------- |
9523
+ | `node` | [`Node`](#node-1) |
9524
+ | `child` | [`Node`](#node-1) |
9525
+
9526
+ ##### Returns
9527
+
9528
+ [`Node`](#node-1)
9529
+
9530
+ ---
9531
+
9532
+ ## Text
9533
+
9534
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1051
9535
+
9536
+ The textual content of Element or Attr. If an element has no markup within its content, it has
9537
+ a single child implementing Text that contains the element's text. However, if the element
9538
+ contains markup, it is parsed into information items and Text nodes that form its children.
9539
+
9540
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Text)
9541
+
9542
+ ### Extends
9543
+
9544
+ - `CharacterData`
9545
+
9546
+ ### Properties
9547
+
9548
+ #### ATTRIBUTE_NODE
9549
+
9550
+ > `readonly` **ATTRIBUTE_NODE**: `2`
9551
+
9552
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:592
9553
+
9554
+ ##### Inherited from
9555
+
9556
+ `CharacterData.ATTRIBUTE_NODE`
9557
+
9558
+ #### baseURI
9559
+
9560
+ > `readonly` **baseURI**: `"about:blank"`
9561
+
9562
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:396
9563
+
9564
+ Always returns `about:blank` currently.
9565
+
9566
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/baseURI)
9567
+
9568
+ ##### Inherited from
9569
+
9570
+ `CharacterData.baseURI`
9571
+
9572
+ #### CDATA_SECTION_NODE
9573
+
9574
+ > `readonly` **CDATA_SECTION_NODE**: `4`
9575
+
9576
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:596
9577
+
9578
+ node is a CDATASection node.
9579
+
9580
+ ##### Inherited from
9581
+
9582
+ `CharacterData.CDATA_SECTION_NODE`
9583
+
9584
+ #### childNodes
9585
+
9586
+ > `readonly` **childNodes**: `NodeList`
9587
+
9588
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:374
9589
+
9590
+ Returns the children.
9591
+
9592
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)
9593
+
9594
+ ##### Inherited from
9595
+
9596
+ `CharacterData.childNodes`
9597
+
9598
+ #### columnNumber?
9599
+
9600
+ > `optional` **columnNumber**: `number`
9601
+
9602
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:479
9603
+
9604
+ One based column position inside the parsed source,
9605
+ if the `locator` was not disabled.
9606
+
9607
+ ##### Inherited from
9608
+
9609
+ `CharacterData.columnNumber`
9610
+
9611
+ #### COMMENT_NODE
9612
+
9613
+ > `readonly` **COMMENT_NODE**: `8`
9614
+
9615
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:602
9616
+
9617
+ node is a Comment node.
9618
+
9619
+ ##### Inherited from
9620
+
9621
+ `CharacterData.COMMENT_NODE`
9622
+
9623
+ #### data
9624
+
9625
+ > **data**: `string`
9626
+
9627
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1019
9628
+
9629
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/data)
9630
+
9631
+ ##### Inherited from
9632
+
9633
+ `CharacterData.data`
9634
+
9635
+ #### DOCUMENT_FRAGMENT_NODE
9636
+
9637
+ > `readonly` **DOCUMENT_FRAGMENT_NODE**: `11`
9638
+
9639
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:608
9640
+
9641
+ node is a DocumentFragment node.
9642
+
9643
+ ##### Inherited from
9644
+
9645
+ `CharacterData.DOCUMENT_FRAGMENT_NODE`
9646
+
9647
+ #### DOCUMENT_NODE
9648
+
9649
+ > `readonly` **DOCUMENT_NODE**: `9`
9650
+
9651
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:604
9652
+
9653
+ node is a document.
9654
+
9655
+ ##### Inherited from
9656
+
9657
+ `CharacterData.DOCUMENT_NODE`
9658
+
9659
+ #### DOCUMENT_POSITION_CONTAINED_BY
9660
+
9661
+ > `readonly` **DOCUMENT_POSITION_CONTAINED_BY**: `16`
9662
+
9663
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:619
9664
+
9665
+ Set when other is a descendant of node.
9666
+
9667
+ ##### Inherited from
9668
+
9669
+ `CharacterData.DOCUMENT_POSITION_CONTAINED_BY`
9670
+
9671
+ #### DOCUMENT_POSITION_CONTAINS
9672
+
9673
+ > `readonly` **DOCUMENT_POSITION_CONTAINS**: `8`
9674
+
9675
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:617
9676
+
9677
+ Set when other is an ancestor of node.
9678
+
9679
+ ##### Inherited from
9680
+
9681
+ `CharacterData.DOCUMENT_POSITION_CONTAINS`
9682
+
9683
+ #### DOCUMENT_POSITION_DISCONNECTED
9684
+
9685
+ > `readonly` **DOCUMENT_POSITION_DISCONNECTED**: `1`
9686
+
9687
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:611
9688
+
9689
+ Set when node and other are not in the same tree.
9690
+
9691
+ ##### Inherited from
9692
+
9693
+ `CharacterData.DOCUMENT_POSITION_DISCONNECTED`
9694
+
9695
+ #### DOCUMENT_POSITION_FOLLOWING
9696
+
9697
+ > `readonly` **DOCUMENT_POSITION_FOLLOWING**: `4`
9698
+
9699
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:615
9700
+
9701
+ Set when other is following node.
9702
+
9703
+ ##### Inherited from
9704
+
9705
+ `CharacterData.DOCUMENT_POSITION_FOLLOWING`
9706
+
9707
+ #### DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
9708
+
9709
+ > `readonly` **DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC**: `32`
9710
+
9711
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:620
9712
+
9713
+ ##### Inherited from
9714
+
9715
+ `CharacterData.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC`
9716
+
9717
+ #### DOCUMENT_POSITION_PRECEDING
9718
+
9719
+ > `readonly` **DOCUMENT_POSITION_PRECEDING**: `2`
9720
+
9721
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:613
9722
+
9723
+ Set when other is preceding node.
9724
+
9725
+ ##### Inherited from
9726
+
9727
+ `CharacterData.DOCUMENT_POSITION_PRECEDING`
9728
+
9729
+ #### DOCUMENT_TYPE_NODE
9730
+
9731
+ > `readonly` **DOCUMENT_TYPE_NODE**: `10`
9732
+
9733
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:606
9734
+
9735
+ node is a doctype.
9736
+
9737
+ ##### Inherited from
9738
+
9739
+ `CharacterData.DOCUMENT_TYPE_NODE`
9740
+
9741
+ #### ELEMENT_NODE
9742
+
9743
+ > `readonly` **ELEMENT_NODE**: `1`
9744
+
9745
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:591
9746
+
9747
+ node is an element.
9748
+
9749
+ ##### Inherited from
9750
+
9751
+ `CharacterData.ELEMENT_NODE`
9752
+
9753
+ #### ENTITY_NODE
9754
+
9755
+ > `readonly` **ENTITY_NODE**: `6`
9756
+
9757
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:598
9758
+
9759
+ ##### Inherited from
9760
+
9761
+ `CharacterData.ENTITY_NODE`
9762
+
9763
+ #### ENTITY_REFERENCE_NODE
9764
+
9765
+ > `readonly` **ENTITY_REFERENCE_NODE**: `5`
9766
+
9767
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:597
9768
+
9769
+ ##### Inherited from
9770
+
9771
+ `CharacterData.ENTITY_REFERENCE_NODE`
9772
+
9773
+ #### firstChild
9774
+
9775
+ > `readonly` **firstChild**: [`Node`](#node-1) \| `null`
9776
+
9777
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:380
9778
+
9779
+ Returns the first child.
9780
+
9781
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)
9782
+
9783
+ ##### Inherited from
9784
+
9785
+ `CharacterData.firstChild`
9786
+
9787
+ #### isConnected
9788
+
9789
+ > `readonly` **isConnected**: `boolean`
9790
+
9791
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:402
9792
+
9793
+ Returns true if this node is inside of a document or is the document node itself.
9794
+
9795
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected)
9796
+
9797
+ ##### Inherited from
9798
+
9799
+ `CharacterData.isConnected`
9800
+
9801
+ #### lastChild
9802
+
9803
+ > `readonly` **lastChild**: [`Node`](#node-1) \| `null`
9804
+
9805
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:386
9806
+
9807
+ Returns the last child.
9808
+
9809
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)
9810
+
9811
+ ##### Inherited from
9812
+
9813
+ `CharacterData.lastChild`
9814
+
9815
+ #### length
9816
+
9817
+ > `readonly` **length**: `number`
9818
+
9819
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1021
9820
+
9821
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/length)
9822
+
9823
+ ##### Inherited from
9824
+
9825
+ `CharacterData.length`
9826
+
9827
+ #### lineNumber?
9828
+
9829
+ > `optional` **lineNumber**: `number`
9830
+
9831
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:474
9832
+
9833
+ Zero based line position inside the parsed source,
9834
+ if the `locator` was not disabled.
9835
+
9836
+ ##### Inherited from
9837
+
9838
+ `CharacterData.lineNumber`
9839
+
9840
+ #### localName
9841
+
9842
+ > **localName**: `string` \| `null`
9843
+
9844
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:390
9845
+
9846
+ The local part of the qualified name of this node.
9847
+
9848
+ ##### Inherited from
9849
+
9850
+ `CharacterData.localName`
9851
+
9852
+ #### namespaceURI
9853
+
9854
+ > `readonly` **namespaceURI**: `string` \| `null`
9855
+
9856
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:406
9857
+
9858
+ The namespace URI of this node.
9859
+
9860
+ ##### Inherited from
9861
+
9862
+ `CharacterData.namespaceURI`
9863
+
9864
+ #### nextSibling
9865
+
9866
+ > `readonly` **nextSibling**: [`Node`](#node-1) \| `null`
9867
+
9868
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:412
9869
+
9870
+ Returns the next sibling.
9871
+
9872
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)
9873
+
9874
+ ##### Inherited from
9875
+
9876
+ `CharacterData.nextSibling`
9877
+
9878
+ #### nodeName
9879
+
9880
+ > **nodeName**: `"#text"` \| `"#cdata-section"`
9881
+
9882
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1052
9883
+
9884
+ Returns a string appropriate for the type of node.
9885
+
9886
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)
9887
+
9888
+ ##### Overrides
9889
+
9890
+ `CharacterData.nodeName`
9891
+
9892
+ #### nodeType
9893
+
9894
+ > **nodeType**: `3` \| `4`
9895
+
9896
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1053
9897
+
9898
+ Returns the type of node.
9899
+
9900
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)
9901
+
9902
+ ##### Overrides
9903
+
9904
+ `CharacterData.nodeType`
9905
+
9906
+ #### nodeValue
9907
+
9908
+ > **nodeValue**: `string` \| `null`
9909
+
9910
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:426
9911
+
9912
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)
9913
+
9914
+ ##### Inherited from
9915
+
9916
+ `CharacterData.nodeValue`
9917
+
9918
+ #### NOTATION_NODE
9919
+
9920
+ > `readonly` **NOTATION_NODE**: `12`
9921
+
9922
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:609
9923
+
9924
+ ##### Inherited from
9925
+
9926
+ `CharacterData.NOTATION_NODE`
9927
+
9928
+ #### ownerDocument
9929
+
9930
+ > `readonly` **ownerDocument**: [`Document`](#document-1)
9931
+
9932
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1022
9933
+
9934
+ Returns the node document. Returns null for documents.
9935
+
9936
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)
9937
+
9938
+ ##### Inherited from
9939
+
9940
+ `CharacterData.ownerDocument`
9941
+
9942
+ #### parentElement
9943
+
9944
+ > `readonly` **parentElement**: [`Element`](#element-1) \| `null`
9945
+
9946
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:444
9947
+
9948
+ Returns the parent `Node` if it is of type `Element`, otherwise `null`.
9949
+
9950
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)
9951
+
9952
+ ##### Inherited from
9953
+
9954
+ `CharacterData.parentElement`
9955
+
9956
+ #### parentNode
9957
+
9958
+ > `readonly` **parentNode**: [`Node`](#node-1) \| `null`
9959
+
9960
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:438
9961
+
9962
+ Returns the parent.
9963
+
9964
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)
9965
+
9966
+ ##### Inherited from
9967
+
9968
+ `CharacterData.parentNode`
9969
+
9970
+ #### prefix
9971
+
9972
+ > **prefix**: `string` \| `null`
9973
+
9974
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:448
9975
+
9976
+ The prefix of the namespace for this node.
9977
+
9978
+ ##### Inherited from
9979
+
9980
+ `CharacterData.prefix`
9981
+
9982
+ #### previousSibling
9983
+
9984
+ > `readonly` **previousSibling**: [`Node`](#node-1) \| `null`
9985
+
9986
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:454
9987
+
9988
+ Returns the previous sibling.
9989
+
9990
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)
9991
+
9992
+ ##### Inherited from
9993
+
9994
+ `CharacterData.previousSibling`
9995
+
9996
+ #### PROCESSING_INSTRUCTION_NODE
9997
+
9998
+ > `readonly` **PROCESSING_INSTRUCTION_NODE**: `7`
9999
+
10000
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:600
10001
+
10002
+ node is a ProcessingInstruction node.
10003
+
10004
+ ##### Inherited from
10005
+
10006
+ `CharacterData.PROCESSING_INSTRUCTION_NODE`
10007
+
10008
+ #### TEXT_NODE
10009
+
10010
+ > `readonly` **TEXT_NODE**: `3`
10011
+
10012
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:594
10013
+
10014
+ node is a Text node.
10015
+
10016
+ ##### Inherited from
10017
+
10018
+ `CharacterData.TEXT_NODE`
10019
+
10020
+ #### textContent
10021
+
10022
+ > **textContent**: `string` \| `null`
10023
+
10024
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:468
10025
+
10026
+ The text content of this node and its descendants.
10027
+
10028
+ For [Element](#element-1) and DocumentFragment nodes, returns the concatenation of the
10029
+ `nodeValue` of every descendant text node, excluding processing instruction and comment
10030
+ nodes. For all other node types, returns `nodeValue`.
10031
+
10032
+ Setting `textContent` on an element or document fragment replaces all child nodes with a
10033
+ single text node; on other nodes it sets `data`, `value`, and `nodeValue` directly.
10034
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/textContent)
10035
+
10036
+ ##### See
10037
+
10038
+ [https://dom.spec.whatwg.org/#dom-node-textcontent](https://dom.spec.whatwg.org/#dom-node-textcontent)
10039
+
10040
+ ##### Inherited from
10041
+
10042
+ `CharacterData.textContent`
10043
+
10044
+ ### Methods
10045
+
10046
+ #### appendChild()
10047
+
10048
+ > **appendChild**(`node`): [`Node`](#node-1)
10049
+
10050
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:482
10051
+
10052
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)
10053
+
10054
+ ##### Parameters
10055
+
10056
+ | Parameter | Type |
10057
+ | --------- | ----------------- |
10058
+ | `node` | [`Node`](#node-1) |
10059
+
10060
+ ##### Returns
10061
+
10062
+ [`Node`](#node-1)
10063
+
10064
+ ##### Inherited from
10065
+
10066
+ `CharacterData.appendChild`
10067
+
10068
+ #### appendData()
10069
+
10070
+ > **appendData**(`data`): `void`
10071
+
10072
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1024
10073
+
10074
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/appendData)
10075
+
10076
+ ##### Parameters
10077
+
10078
+ | Parameter | Type |
10079
+ | --------- | -------- |
10080
+ | `data` | `string` |
10081
+
10082
+ ##### Returns
10083
+
10084
+ `void`
10085
+
10086
+ ##### Inherited from
10087
+
10088
+ `CharacterData.appendData`
10089
+
10090
+ #### cloneNode()
10091
+
10092
+ > **cloneNode**(`deep?`): [`Node`](#node-1)
10093
+
10094
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:533
10095
+
10096
+ Returns a copy of node. If deep is true, the copy also includes the node's descendants.
10097
+
10098
+ ##### Parameters
10099
+
10100
+ | Parameter | Type |
10101
+ | --------- | --------- |
10102
+ | `deep?` | `boolean` |
10103
+
10104
+ ##### Returns
10105
+
10106
+ [`Node`](#node-1)
10107
+
10108
+ ##### Throws
10109
+
10110
+ May throw a DOMException if operations within [Element#setAttributeNode](#setattributenode) or
10111
+ [Node#appendChild](#appendchild-8) (which are potentially invoked in this method) do not meet their
10112
+ specific constraints.
10113
+
10114
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)
10115
+
10116
+ ##### Inherited from
10117
+
10118
+ `CharacterData.cloneNode`
10119
+
10120
+ #### compareDocumentPosition()
10121
+
10122
+ > **compareDocumentPosition**(`other`): `number`
10123
+
10124
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:540
10125
+
10126
+ Returns a bitmask indicating the position of other relative to node.
10127
+
10128
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)
10129
+
10130
+ ##### Parameters
10131
+
10132
+ | Parameter | Type |
10133
+ | --------- | ----------------- |
10134
+ | `other` | [`Node`](#node-1) |
10135
+
10136
+ ##### Returns
10137
+
10138
+ `number`
10139
+
10140
+ ##### Inherited from
10141
+
10142
+ `CharacterData.compareDocumentPosition`
10143
+
10144
+ #### contains()
10145
+
10146
+ > **contains**(`other`): `boolean`
10147
+
10148
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:489
10149
+
10150
+ Checks whether `other` is an inclusive descendant of this node.
10151
+
10152
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/contains)
10153
+
10154
+ ##### Parameters
10155
+
10156
+ | Parameter | Type |
10157
+ | --------- | ------------------------------------------ |
10158
+ | `other` | [`Node`](#node-1) \| `null` \| `undefined` |
10159
+
10160
+ ##### Returns
10161
+
10162
+ `boolean`
10163
+
10164
+ ##### Inherited from
10165
+
10166
+ `CharacterData.contains`
10167
+
10168
+ #### deleteData()
10169
+
10170
+ > **deleteData**(`offset`, `count`): `void`
10171
+
10172
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1026
10173
+
10174
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/deleteData)
10175
+
10176
+ ##### Parameters
10177
+
10178
+ | Parameter | Type |
10179
+ | --------- | -------- |
10180
+ | `offset` | `number` |
10181
+ | `count` | `number` |
10182
+
10183
+ ##### Returns
10184
+
10185
+ `void`
10186
+
10187
+ ##### Inherited from
10188
+
10189
+ `CharacterData.deleteData`
10190
+
10191
+ #### getRootNode()
10192
+
10193
+ > **getRootNode**(`options`): [`Node`](#node-1)
10194
+
10195
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:502
10196
+
10197
+ Searches for the root node of this node.
10198
+
10199
+ **This behavior is slightly different from the one in the specs**:
10200
+
10201
+ - ignores `options.composed`, since `ShadowRoot`s are unsupported, therefore always
10202
+ returning root.
10203
+
10204
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/getRootNode)
10205
+
10206
+ ##### Parameters
10207
+
10208
+ | Parameter | Type |
10209
+ | --------- | -------------------- |
10210
+ | `options` | `GetRootNodeOptions` |
10211
+
10212
+ ##### Returns
10213
+
10214
+ [`Node`](#node-1)
10215
+
10216
+ ##### See
10217
+
10218
+ - https://dom.spec.whatwg.org/#dom-node-getrootnode
10219
+ - https://dom.spec.whatwg.org/#concept-shadow-including-root
10220
+
10221
+ ##### Inherited from
10222
+
10223
+ `CharacterData.getRootNode`
10224
+
10225
+ #### hasChildNodes()
10226
+
10227
+ > **hasChildNodes**(): `boolean`
10228
+
10229
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:547
10230
+
10231
+ Returns whether node has children.
10232
+
10233
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)
10234
+
10235
+ ##### Returns
10236
+
10237
+ `boolean`
10238
+
10239
+ ##### Inherited from
10240
+
10241
+ `CharacterData.hasChildNodes`
10242
+
10243
+ #### insertBefore()
10244
+
10245
+ > **insertBefore**(`node`, `child`): [`Node`](#node-1)
10246
+
10247
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:550
10248
+
10249
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)
10250
+
10251
+ ##### Parameters
10252
+
10253
+ | Parameter | Type |
10254
+ | --------- | --------------------------- |
10255
+ | `node` | [`Node`](#node-1) |
10256
+ | `child` | [`Node`](#node-1) \| `null` |
10257
+
10258
+ ##### Returns
10259
+
10260
+ [`Node`](#node-1)
10261
+
10262
+ ##### Inherited from
10263
+
10264
+ `CharacterData.insertBefore`
10265
+
10266
+ #### insertData()
10267
+
10268
+ > **insertData**(`offset`, `data`): `void`
10269
+
10270
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1028
10271
+
10272
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/insertData)
10273
+
10274
+ ##### Parameters
10275
+
10276
+ | Parameter | Type |
10277
+ | --------- | -------- |
10278
+ | `offset` | `number` |
10279
+ | `data` | `string` |
10280
+
10281
+ ##### Returns
10282
+
10283
+ `void`
10284
+
10285
+ ##### Inherited from
10286
+
10287
+ `CharacterData.insertData`
10288
+
10289
+ #### isDefaultNamespace()
10290
+
10291
+ > **isDefaultNamespace**(`namespace`): `boolean`
10292
+
10293
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:553
10294
+
10295
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)
10296
+
10297
+ ##### Parameters
10298
+
10299
+ | Parameter | Type |
10300
+ | ----------- | ------------------ |
10301
+ | `namespace` | `string` \| `null` |
10302
+
10303
+ ##### Returns
10304
+
10305
+ `boolean`
10306
+
10307
+ ##### Inherited from
10308
+
10309
+ `CharacterData.isDefaultNamespace`
10310
+
10311
+ #### isEqualNode()
10312
+
10313
+ > **isEqualNode**(`other`): `boolean`
10314
+
10315
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:514
10316
+
10317
+ Checks whether the given node is equal to this node.
10318
+
10319
+ Two nodes are equal when they have the same type, defining characteristics (for the type),
10320
+ and the same `childNodes`. The comparison is iterative to avoid stack overflows on deeply
10321
+ nested trees. `Attribute` nodes of each `Element` pair are also compared iteratively.
10322
+
10323
+ ##### Parameters
10324
+
10325
+ | Parameter | Type |
10326
+ | --------- | ----------------- |
10327
+ | `other` | [`Node`](#node-1) |
10328
+
10329
+ ##### Returns
10330
+
10331
+ `boolean`
10332
+
10333
+ ##### See
10334
+
10335
+ - [https://dom.spec.whatwg.org/#concept-node-equals](https://dom.spec.whatwg.org/#concept-node-equals)
10336
+ - [https://developer.mozilla.org/en-US/docs/Web/API/Node/isEqualNode](https://developer.mozilla.org/en-US/docs/Web/API/Node/isEqualNode)
10337
+
10338
+ ##### Inherited from
10339
+
10340
+ `CharacterData.isEqualNode`
10341
+
10342
+ #### isSameNode()
10343
+
10344
+ > **isSameNode**(`other`): `boolean`
10345
+
10346
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:521
10347
+
10348
+ Checks whether the given node is this node.
10349
+
10350
+ [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/isSameNode)
10351
+
10352
+ ##### Parameters
10353
+
10354
+ | Parameter | Type |
10355
+ | --------- | ----------------- |
10356
+ | `other` | [`Node`](#node-1) |
10357
+
10358
+ ##### Returns
10359
+
10360
+ `boolean`
10361
+
10362
+ ##### Inherited from
10363
+
10364
+ `CharacterData.isSameNode`
10365
+
10366
+ #### ~~isSupported()~~
10367
+
10368
+ > **isSupported**(`feature`, `version`): `true`
10369
+
10370
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:568
10371
+
10372
+ Checks whether the DOM implementation implements a specific feature and its version.
10373
+
10374
+ ##### Parameters
10375
+
10376
+ | Parameter | Type | Description |
10377
+ | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
10378
+ | `feature` | `string` | The package name of the feature to test. This is the same name that can be passed to the method `hasFeature` on `DOMImplementation`. |
10379
+ | `version` | `string` | This is the version number of the package name to test. |
10380
+
10381
+ ##### Returns
10382
+
10383
+ `true`
10384
+
10385
+ ##### Deprecated
10386
+
10387
+ Since `DOMImplementation.hasFeature` is deprecated and always returns true.
10388
+
10389
+ ##### Since
10390
+
10391
+ Introduced in DOM Level 2
10392
+
10393
+ ##### See
10394
+
10395
+ DOMImplementation.hasFeature
10396
+
10397
+ ##### Inherited from
10398
+
10399
+ `CharacterData.isSupported`
10400
+
10401
+ #### lookupNamespaceURI()
10402
+
10403
+ > **lookupNamespaceURI**(`prefix`): `string` \| `null`
10404
+
10405
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:571
10406
+
10407
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)
10408
+
10409
+ ##### Parameters
10410
+
10411
+ | Parameter | Type |
10412
+ | --------- | ------------------ |
10413
+ | `prefix` | `string` \| `null` |
10414
+
10415
+ ##### Returns
10416
+
10417
+ `string` \| `null`
10418
+
10419
+ ##### Inherited from
10420
+
10421
+ `CharacterData.lookupNamespaceURI`
10422
+
10423
+ #### lookupPrefix()
10424
+
10425
+ > **lookupPrefix**(`namespace`): `string` \| `null`
10426
+
10427
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:574
10428
+
10429
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)
10430
+
10431
+ ##### Parameters
10432
+
10433
+ | Parameter | Type |
10434
+ | ----------- | ------------------ |
10435
+ | `namespace` | `string` \| `null` |
10436
+
10437
+ ##### Returns
10438
+
10439
+ `string` \| `null`
10440
+
10441
+ ##### Inherited from
10442
+
10443
+ `CharacterData.lookupPrefix`
10444
+
10445
+ #### normalize()
10446
+
10447
+ > **normalize**(): `void`
10448
+
10449
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:582
10450
+
10451
+ Removes empty exclusive Text nodes and concatenates the data of remaining contiguous
10452
+ exclusive Text nodes into the first of their nodes.
10453
+
10454
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)
10455
+
10456
+ ##### Returns
10457
+
10458
+ `void`
10459
+
10460
+ ##### Inherited from
10461
+
10462
+ `CharacterData.normalize`
10463
+
10464
+ #### removeChild()
10465
+
10466
+ > **removeChild**(`child`): [`Node`](#node-1)
10467
+
10468
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:585
10469
+
10470
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)
10471
+
10472
+ ##### Parameters
10473
+
10474
+ | Parameter | Type |
10475
+ | --------- | ----------------- |
10476
+ | `child` | [`Node`](#node-1) |
10477
+
10478
+ ##### Returns
10479
+
10480
+ [`Node`](#node-1)
10481
+
10482
+ ##### Inherited from
10483
+
10484
+ `CharacterData.removeChild`
10485
+
10486
+ #### replaceChild()
10487
+
10488
+ > **replaceChild**(`node`, `child`): [`Node`](#node-1)
10489
+
10490
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:588
10491
+
10492
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)
10493
+
10494
+ ##### Parameters
10495
+
10496
+ | Parameter | Type |
10497
+ | --------- | ----------------- |
10498
+ | `node` | [`Node`](#node-1) |
10499
+ | `child` | [`Node`](#node-1) |
10500
+
10501
+ ##### Returns
10502
+
10503
+ [`Node`](#node-1)
10504
+
10505
+ ##### Inherited from
10506
+
10507
+ `CharacterData.replaceChild`
10508
+
10509
+ #### replaceData()
10510
+
10511
+ > **replaceData**(`offset`, `count`, `data`): `void`
10512
+
10513
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1030
10514
+
10515
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceData)
10516
+
10517
+ ##### Parameters
10518
+
10519
+ | Parameter | Type |
10520
+ | --------- | -------- |
10521
+ | `offset` | `number` |
10522
+ | `count` | `number` |
10523
+ | `data` | `string` |
10524
+
10525
+ ##### Returns
10526
+
10527
+ `void`
10528
+
10529
+ ##### Inherited from
10530
+
10531
+ `CharacterData.replaceData`
10532
+
10533
+ #### splitText()
10534
+
10535
+ > **splitText**(`offset`): [`Text`](#text-1)
10536
+
10537
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1059
10538
+
10539
+ Splits data at the given offset and returns the remainder as Text node.
10540
+
10541
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Text/splitText)
10542
+
10543
+ ##### Parameters
10544
+
10545
+ | Parameter | Type |
10546
+ | --------- | -------- |
10547
+ | `offset` | `number` |
10548
+
10549
+ ##### Returns
10550
+
10551
+ [`Text`](#text-1)
10552
+
10553
+ #### substringData()
10554
+
10555
+ > **substringData**(`offset`, `count`): `string`
10556
+
10557
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1032
10558
+
10559
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/substringData)
10560
+
10561
+ ##### Parameters
10562
+
10563
+ | Parameter | Type |
10564
+ | --------- | -------- |
10565
+ | `offset` | `number` |
10566
+ | `count` | `number` |
10567
+
10568
+ ##### Returns
10569
+
10570
+ `string`
10571
+
10572
+ ##### Inherited from
10573
+
10574
+ `CharacterData.substringData`
10575
+
10576
+ ---
10577
+
10578
+ ## AdapterOptions\<A\>
10579
+
10580
+ > **AdapterOptions**\<`A`\> = `A` _extends_ [`EpubStorageAdapterClass`](#epubstorageadapterclass)\<infer Opts\> ? `Opts` : `object`
10581
+
10582
+ Defined in: [libraries/epub/src/adapters/interface.ts:110](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L110)
10583
+
10584
+ ### Type Parameters
10585
+
10586
+ | Type Parameter |
10587
+ | -------------- |
10588
+ | `A` |
10589
+
10590
+ ---
10591
+
10592
+ ## ArchiveSource
10593
+
10594
+ > **ArchiveSource** = `string` \| `Uint8Array` \| `Blob`
10595
+
10596
+ Defined in: [libraries/epub/src/adapters/interface.ts:12](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L12)
10597
+
10598
+ ---
10599
+
10600
+ ## Attr
10601
+
10602
+ > **Attr** = `InstanceOf`\<[`Attr`](#attr-1)\>
10603
+
10604
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:664
10605
+
10606
+ A DOM element's attribute as an object. In most DOM methods, you will probably directly
10607
+ retrieve the attribute as a string (e.g., Element.getAttribute(), but certain functions (e.g.,
10608
+ Element.getAttributeNode()) or means of iterating give Attr types.
10609
+
10610
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr)
10611
+
10612
+ ---
10613
+
10614
+ ## Document
10615
+
10616
+ > **Document** = `InstanceOf`\<[`Document`](#document-1)\>
10617
+
10618
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1188
10619
+
10620
+ ---
10621
+
10622
+ ## DocumentType
10623
+
10624
+ > **DocumentType** = `InstanceOf`\<`DocumentFragment`\>
10625
+
10626
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:1431
10627
+
10628
+ ---
10629
+
10630
+ ## Element
10631
+
10632
+ > **Element** = `InstanceOf`\<[`Element`](#element-1)\>
10633
+
10634
+ Defined in: node_modules/@xmldom/xmldom/index.d.ts:842
10635
+
10636
+ Element is the most general base class from which all objects in a Document inherit. It only
10637
+ has methods and properties common to all kinds of elements. More specific classes inherit from
10638
+ Element.
10639
+
10640
+ [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element)
10641
+
10642
+ ---
10643
+
10644
+ ## EpubInstanceFor\<A\>
10645
+
10646
+ > **EpubInstanceFor**\<`A`\> = `A`\[`"capabilities"`\]\[`"writable"`\] _extends_ `true` ? [`Epub`](#epub) : [`EpubReader`](#epubreader)
10647
+
10648
+ Defined in: [libraries/epub/src/index.tsx:3384](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L3384)
10649
+
10650
+ Resolves to [Epub](#epub) for writable adapters, [EpubReader](#epubreader) for read-only ones.
10651
+
10652
+ The conditional pivots on `capabilities.writable`, which must be a literal
10653
+ `true`/`false` on the adapter class (use `as const`) for inference to work.
10654
+
10655
+ ### Type Parameters
10656
+
10657
+ | Type Parameter |
10658
+ | ------------------------------------------------------------------- |
10659
+ | `A` _extends_ [`EpubStorageAdapterClass`](#epubstorageadapterclass) |
10660
+
10661
+ ---
10662
+
10663
+ ## EpubMetadata
10664
+
10665
+ > **EpubMetadata** = [`MetadataEntry`](#metadataentry)[]
10666
+
10667
+ Defined in: [libraries/epub/src/index.tsx:136](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L136)
10668
+
10669
+ ---
10670
+
10671
+ ## EpubReader
10672
+
10673
+ > **EpubReader** = `Pick`\<[`Epub`](#epub), `"storage"` \| `"findMetadataItem"` \| `"findAllMetadataItems"` \| `"resolveHref"` \| `"readFileContents"` \| `"readItemContents"` \| `"readXhtmlItemContents"` \| `"discardAndClose"` \| `Extract`\<keyof [`Epub`](#epub), `` `get${string}` ``\>\> & `Disposable`
10674
+
10675
+ Defined in: [libraries/epub/src/index.tsx:234](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L234)
10676
+
10677
+ Read-only view of an EPUB
10678
+ Returned by Epub.using(MemoryAdapter).from(...) and by Epub.from(path, { readonly: true })
10679
+
10680
+ ---
10681
+
10682
+ ## EpubStorageKind
10683
+
10684
+ > **EpubStorageKind** = `"tmp-dir"` \| `"in-memory"` \| `string` & `object`
10685
+
10686
+ Defined in: [libraries/epub/src/adapters/interface.ts:10](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/adapters/interface.ts#L10)
10687
+
10688
+ Pluggable storage backend for an Epub instance
10689
+
10690
+ Built-in adapters:
10691
+
10692
+ - [TmpFsAdapter](#tmpfsadapter) extracts the archive to a tmp directory and
10693
+ supports the full read/write/save/upgrade
10694
+ - [MemoryAdapter](#memoryadapter) keeps an in-memory zip handle and supports
10695
+ reads only
10696
+
10697
+ ---
10698
+
10699
+ ## InMemoryEpubReader
10700
+
10701
+ > **InMemoryEpubReader** = [`EpubReader`](#epubreader) & `object`
10702
+
10703
+ Defined in: [libraries/epub/src/index.tsx:252](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L252)
10704
+
10705
+ Readonly Epub-instance backed by an in-memory zip handle
10706
+ Returned by `Epub.using(MemoryAdapter).from(...)`
10707
+
10708
+ ### Type Declaration
10709
+
10710
+ #### storage
10711
+
10712
+ > `readonly` **storage**: `"in-memory"`
10713
+
10714
+ ---
10715
+
10716
+ ## ManifestItem
10717
+
10718
+ > **ManifestItem** = `object`
10719
+
10720
+ Defined in: [libraries/epub/src/index.tsx:119](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/libraries/epub/src/index.tsx#L119)
10721
+
10722
+ ### Properties
10723
+
10724
+ #### fallback?
10725
+
10726
+ > `optional` **fallback*