@storyteller-platform/epub 0.4.2 → 0.4.6
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 +125 -125
- package/dist/index.cjs +60 -86
- package/dist/index.js +60 -86
- package/package.json +7 -5
package/README.md
CHANGED
|
@@ -220,7 +220,7 @@ To get started with developing in the Storyteller monorepo, check out the
|
|
|
220
220
|
## Epub
|
|
221
221
|
|
|
222
222
|
Defined in:
|
|
223
|
-
[epub/index.ts:
|
|
223
|
+
[epub/index.ts:167](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L167)
|
|
224
224
|
|
|
225
225
|
A single EPUB instance.
|
|
226
226
|
|
|
@@ -262,7 +262,7 @@ https://www.w3.org/TR/epub-33/
|
|
|
262
262
|
> `protected` **new Epub**(`extractPath`, `inputPath`): [`Epub`](#epub)
|
|
263
263
|
|
|
264
264
|
Defined in:
|
|
265
|
-
[epub/index.ts:
|
|
265
|
+
[epub/index.ts:379](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L379)
|
|
266
266
|
|
|
267
267
|
##### Parameters
|
|
268
268
|
|
|
@@ -282,42 +282,42 @@ Defined in:
|
|
|
282
282
|
> `protected` **extractPath**: `string`
|
|
283
283
|
|
|
284
284
|
Defined in:
|
|
285
|
-
[epub/index.ts:
|
|
285
|
+
[epub/index.ts:380](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L380)
|
|
286
286
|
|
|
287
287
|
#### inputPath
|
|
288
288
|
|
|
289
289
|
> `protected` **inputPath**: `undefined` \| `string`
|
|
290
290
|
|
|
291
291
|
Defined in:
|
|
292
|
-
[epub/index.ts:
|
|
292
|
+
[epub/index.ts:381](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L381)
|
|
293
293
|
|
|
294
294
|
#### xhtmlBuilder
|
|
295
295
|
|
|
296
296
|
> `static` **xhtmlBuilder**: `XMLBuilder`
|
|
297
297
|
|
|
298
298
|
Defined in:
|
|
299
|
-
[epub/index.ts:
|
|
299
|
+
[epub/index.ts:215](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L215)
|
|
300
300
|
|
|
301
301
|
#### xhtmlParser
|
|
302
302
|
|
|
303
303
|
> `static` **xhtmlParser**: `XMLParser`
|
|
304
304
|
|
|
305
305
|
Defined in:
|
|
306
|
-
[epub/index.ts:
|
|
306
|
+
[epub/index.ts:175](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L175)
|
|
307
307
|
|
|
308
308
|
#### xmlBuilder
|
|
309
309
|
|
|
310
310
|
> `static` **xmlBuilder**: `XMLBuilder`
|
|
311
311
|
|
|
312
312
|
Defined in:
|
|
313
|
-
[epub/index.ts:
|
|
313
|
+
[epub/index.ts:208](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L208)
|
|
314
314
|
|
|
315
315
|
#### xmlParser
|
|
316
316
|
|
|
317
317
|
> `static` **xmlParser**: `XMLParser`
|
|
318
318
|
|
|
319
319
|
Defined in:
|
|
320
|
-
[epub/index.ts:
|
|
320
|
+
[epub/index.ts:168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L168)
|
|
321
321
|
|
|
322
322
|
### Methods
|
|
323
323
|
|
|
@@ -326,7 +326,7 @@ Defined in:
|
|
|
326
326
|
> **\[dispose\]**(): `void`
|
|
327
327
|
|
|
328
328
|
Defined in:
|
|
329
|
-
[epub/index.ts:
|
|
329
|
+
[epub/index.ts:2493](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2493)
|
|
330
330
|
|
|
331
331
|
##### Returns
|
|
332
332
|
|
|
@@ -337,7 +337,7 @@ Defined in:
|
|
|
337
337
|
> **addCollection**(`collection`, `index?`): `Promise`\<`void`\>
|
|
338
338
|
|
|
339
339
|
Defined in:
|
|
340
|
-
[epub/index.ts:
|
|
340
|
+
[epub/index.ts:1520](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1520)
|
|
341
341
|
|
|
342
342
|
Add a collection to the EPUB metadata.
|
|
343
343
|
|
|
@@ -360,7 +360,7 @@ collections. Otherwise, it will be added to the end of the list.
|
|
|
360
360
|
> **addContributor**(`contributor`, `index?`): `Promise`\<`void`\>
|
|
361
361
|
|
|
362
362
|
Defined in:
|
|
363
|
-
[epub/index.ts:
|
|
363
|
+
[epub/index.ts:1862](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1862)
|
|
364
364
|
|
|
365
365
|
Add a contributor to the EPUB metadata.
|
|
366
366
|
|
|
@@ -390,7 +390,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
|
|
|
390
390
|
> **addCreator**(`creator`, `index?`, `type?`): `Promise`\<`void`\>
|
|
391
391
|
|
|
392
392
|
Defined in:
|
|
393
|
-
[epub/index.ts:
|
|
393
|
+
[epub/index.ts:1707](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1707)
|
|
394
394
|
|
|
395
395
|
Add a creator to the EPUB metadata.
|
|
396
396
|
|
|
@@ -420,7 +420,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
|
|
|
420
420
|
> **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
|
|
421
421
|
|
|
422
422
|
Defined in:
|
|
423
|
-
[epub/index.ts:
|
|
423
|
+
[epub/index.ts:2189](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2189)
|
|
424
424
|
|
|
425
425
|
Create a new manifest item and write its contents to a new entry.
|
|
426
426
|
|
|
@@ -449,7 +449,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
|
|
|
449
449
|
> **addManifestItem**(`item`, `contents`, `encoding`): `Promise`\<`void`\>
|
|
450
450
|
|
|
451
451
|
Defined in:
|
|
452
|
-
[epub/index.ts:
|
|
452
|
+
[epub/index.ts:2194](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2194)
|
|
453
453
|
|
|
454
454
|
Create a new manifest item and write its contents to a new entry.
|
|
455
455
|
|
|
@@ -478,7 +478,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
|
|
|
478
478
|
> **addManifestItem**(`item`, `contents`): `Promise`\<`void`\>
|
|
479
479
|
|
|
480
480
|
Defined in:
|
|
481
|
-
[epub/index.ts:
|
|
481
|
+
[epub/index.ts:2199](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2199)
|
|
482
482
|
|
|
483
483
|
Create a new manifest item and write its contents to a new entry.
|
|
484
484
|
|
|
@@ -506,7 +506,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
|
|
|
506
506
|
> **addMetadata**(`entry`): `Promise`\<`void`\>
|
|
507
507
|
|
|
508
508
|
Defined in:
|
|
509
|
-
[epub/index.ts:
|
|
509
|
+
[epub/index.ts:2311](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2311)
|
|
510
510
|
|
|
511
511
|
Add a new metadata entry to the Epub.
|
|
512
512
|
|
|
@@ -533,7 +533,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
|
|
|
533
533
|
> **addSpineItem**(`manifestId`, `index?`): `Promise`\<`void`\>
|
|
534
534
|
|
|
535
535
|
Defined in:
|
|
536
|
-
[epub/index.ts:
|
|
536
|
+
[epub/index.ts:1916](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1916)
|
|
537
537
|
|
|
538
538
|
Add an item to the spine of the EPUB.
|
|
539
539
|
|
|
@@ -563,7 +563,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
|
|
|
563
563
|
> **addSubject**(`subject`): `Promise`\<`void`\>
|
|
564
564
|
|
|
565
565
|
Defined in:
|
|
566
|
-
[epub/index.ts:
|
|
566
|
+
[epub/index.ts:1049](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1049)
|
|
567
567
|
|
|
568
568
|
Add a subject to the EPUB metadata.
|
|
569
569
|
|
|
@@ -588,7 +588,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
|
|
|
588
588
|
> [`XmlElement`](#xmlelement)\<`"?xml"`\>)[]\>
|
|
589
589
|
|
|
590
590
|
Defined in:
|
|
591
|
-
[epub/index.ts:
|
|
591
|
+
[epub/index.ts:2017](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2017)
|
|
592
592
|
|
|
593
593
|
Create a new XHTML document with the given body and head.
|
|
594
594
|
|
|
@@ -610,7 +610,7 @@ Create a new XHTML document with the given body and head.
|
|
|
610
610
|
> **discardAndClose**(): `void`
|
|
611
611
|
|
|
612
612
|
Defined in:
|
|
613
|
-
[epub/index.ts:
|
|
613
|
+
[epub/index.ts:2420](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2420)
|
|
614
614
|
|
|
615
615
|
##### Returns
|
|
616
616
|
|
|
@@ -621,7 +621,7 @@ Defined in:
|
|
|
621
621
|
> **findAllMetadataItems**(`predicate`): `Promise`\<`object`[]\>
|
|
622
622
|
|
|
623
623
|
Defined in:
|
|
624
|
-
[epub/index.ts:
|
|
624
|
+
[epub/index.ts:772](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L772)
|
|
625
625
|
|
|
626
626
|
Returns the item in the metadata element's children array that matches the
|
|
627
627
|
provided predicate.
|
|
@@ -661,7 +661,7 @@ provided predicate.
|
|
|
661
661
|
> \}\>
|
|
662
662
|
|
|
663
663
|
Defined in:
|
|
664
|
-
[epub/index.ts:
|
|
664
|
+
[epub/index.ts:763](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L763)
|
|
665
665
|
|
|
666
666
|
Returns the item in the metadata element's children array that matches the
|
|
667
667
|
provided predicate.
|
|
@@ -700,7 +700,7 @@ provided predicate.
|
|
|
700
700
|
> **getCollections**(): `Promise`\<[`Collection`](#collection)[]\>
|
|
701
701
|
|
|
702
702
|
Defined in:
|
|
703
|
-
[epub/index.ts:
|
|
703
|
+
[epub/index.ts:1480](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1480)
|
|
704
704
|
|
|
705
705
|
Retrieve the list of collections.
|
|
706
706
|
|
|
@@ -713,7 +713,7 @@ Retrieve the list of collections.
|
|
|
713
713
|
> **getContributors**(): `Promise`\<[`DcCreator`](#dccreator)[]\>
|
|
714
714
|
|
|
715
715
|
Defined in:
|
|
716
|
-
[epub/index.ts:
|
|
716
|
+
[epub/index.ts:1694](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1694)
|
|
717
717
|
|
|
718
718
|
Retrieve the list of contributors.
|
|
719
719
|
|
|
@@ -732,7 +732,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccontributor
|
|
|
732
732
|
> **getCoverImage**(): `Promise`\<`null` \| `Uint8Array`\<`ArrayBufferLike`\>\>
|
|
733
733
|
|
|
734
734
|
Defined in:
|
|
735
|
-
[epub/index.ts:
|
|
735
|
+
[epub/index.ts:952](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L952)
|
|
736
736
|
|
|
737
737
|
Retrieve the cover image data as a byte array.
|
|
738
738
|
|
|
@@ -753,7 +753,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
|
|
|
753
753
|
> [`ManifestItem`](#manifestitem)\>
|
|
754
754
|
|
|
755
755
|
Defined in:
|
|
756
|
-
[epub/index.ts:
|
|
756
|
+
[epub/index.ts:933](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L933)
|
|
757
757
|
|
|
758
758
|
Retrieve the cover image manifest item.
|
|
759
759
|
|
|
@@ -773,7 +773,7 @@ https://www.w3.org/TR/epub-33/#sec-cover-image
|
|
|
773
773
|
> **getCreators**(`type`): `Promise`\<[`DcCreator`](#dccreator)[]\>
|
|
774
774
|
|
|
775
775
|
Defined in:
|
|
776
|
-
[epub/index.ts:
|
|
776
|
+
[epub/index.ts:1633](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1633)
|
|
777
777
|
|
|
778
778
|
Retrieve the list of creators.
|
|
779
779
|
|
|
@@ -796,7 +796,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
|
|
|
796
796
|
> **getDescription**(): `Promise`\<`null` \| `string`\>
|
|
797
797
|
|
|
798
798
|
Defined in:
|
|
799
|
-
[epub/index.ts:
|
|
799
|
+
[epub/index.ts:1331](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1331)
|
|
800
800
|
|
|
801
801
|
Retrieve the Epub's description as specified in its package document metadata.
|
|
802
802
|
|
|
@@ -812,7 +812,7 @@ as a string. Descriptions may include HTML markup.
|
|
|
812
812
|
> **getIdentifier**(): `Promise`\<`null` \| `string`\>
|
|
813
813
|
|
|
814
814
|
Defined in:
|
|
815
|
-
[epub/index.ts:
|
|
815
|
+
[epub/index.ts:867](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L867)
|
|
816
816
|
|
|
817
817
|
Retrieve the identifier from the dc:identifier element in the EPUB metadata.
|
|
818
818
|
|
|
@@ -831,7 +831,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
|
|
|
831
831
|
> **getLanguage**(): `Promise`\<`null` \| `Locale`\>
|
|
832
832
|
|
|
833
833
|
Defined in:
|
|
834
|
-
[epub/index.ts:
|
|
834
|
+
[epub/index.ts:1168](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1168)
|
|
835
835
|
|
|
836
836
|
Retrieve the Epub's language as specified in its package document metadata.
|
|
837
837
|
|
|
@@ -852,7 +852,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
|
|
|
852
852
|
> [`ManifestItem`](#manifestitem)\>\>
|
|
853
853
|
|
|
854
854
|
Defined in:
|
|
855
|
-
[epub/index.ts:
|
|
855
|
+
[epub/index.ts:688](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L688)
|
|
856
856
|
|
|
857
857
|
Retrieve the manifest for the Epub.
|
|
858
858
|
|
|
@@ -872,7 +872,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
|
|
|
872
872
|
> **getMetadata**(): `Promise`\<[`EpubMetadata`](#epubmetadata)\>
|
|
873
873
|
|
|
874
874
|
Defined in:
|
|
875
|
-
[epub/index.ts:
|
|
875
|
+
[epub/index.ts:839](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L839)
|
|
876
876
|
|
|
877
877
|
Retrieve the metadata entries for the Epub.
|
|
878
878
|
|
|
@@ -896,7 +896,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
|
|
|
896
896
|
> `string`\>\>
|
|
897
897
|
|
|
898
898
|
Defined in:
|
|
899
|
-
[epub/index.ts:
|
|
899
|
+
[epub/index.ts:1348](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1348)
|
|
900
900
|
|
|
901
901
|
Return the set of custom vocabulary prefixes set on this publication's root
|
|
902
902
|
package element.
|
|
@@ -916,7 +916,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
|
|
|
916
916
|
> **getPublicationDate**(): `Promise`\<`null` \| `Date`\>
|
|
917
917
|
|
|
918
918
|
Defined in:
|
|
919
|
-
[epub/index.ts:
|
|
919
|
+
[epub/index.ts:989](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L989)
|
|
920
920
|
|
|
921
921
|
Retrieve the publication date from the dc:date element in the EPUB metadata as a
|
|
922
922
|
Date object.
|
|
@@ -936,7 +936,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
|
|
|
936
936
|
> **getSpineItems**(): `Promise`\<[`ManifestItem`](#manifestitem)[]\>
|
|
937
937
|
|
|
938
938
|
Defined in:
|
|
939
|
-
[epub/index.ts:
|
|
939
|
+
[epub/index.ts:1897](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1897)
|
|
940
940
|
|
|
941
941
|
Retrieve the manifest items that make up the Epub's spine.
|
|
942
942
|
|
|
@@ -956,7 +956,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
|
|
|
956
956
|
> **getSubjects**(): `Promise`\<(`string` \| [`DcSubject`](#dcsubject))[]\>
|
|
957
957
|
|
|
958
958
|
Defined in:
|
|
959
|
-
[epub/index.ts:
|
|
959
|
+
[epub/index.ts:1123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1123)
|
|
960
960
|
|
|
961
961
|
Retrieve the list of subjects for this EPUB.
|
|
962
962
|
|
|
@@ -977,7 +977,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcsubject
|
|
|
977
977
|
> **getSubtitle**(): `Promise`\<`null` \| `string`\>
|
|
978
978
|
|
|
979
979
|
Defined in:
|
|
980
|
-
[epub/index.ts:
|
|
980
|
+
[epub/index.ts:1238](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1238)
|
|
981
981
|
|
|
982
982
|
Retrieve the subtitle of the Epub, if it exists.
|
|
983
983
|
|
|
@@ -994,7 +994,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
|
|
|
994
994
|
> **getTitle**(`expanded`): `Promise`\<`null` \| `string`\>
|
|
995
995
|
|
|
996
996
|
Defined in:
|
|
997
|
-
[epub/index.ts:
|
|
997
|
+
[epub/index.ts:1214](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1214)
|
|
998
998
|
|
|
999
999
|
Retrieve the title of the Epub.
|
|
1000
1000
|
|
|
@@ -1017,7 +1017,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
|
|
|
1017
1017
|
> **getTitles**(): `Promise`\<`object`[]\>
|
|
1018
1018
|
|
|
1019
1019
|
Defined in:
|
|
1020
|
-
[epub/index.ts:
|
|
1020
|
+
[epub/index.ts:1250](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1250)
|
|
1021
1021
|
|
|
1022
1022
|
Retrieve all title entries of the Epub.
|
|
1023
1023
|
|
|
@@ -1034,7 +1034,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
|
|
|
1034
1034
|
> **getType**(): `Promise`\<`null` \| [`MetadataEntry`](#metadataentry)\>
|
|
1035
1035
|
|
|
1036
1036
|
Defined in:
|
|
1037
|
-
[epub/index.ts:
|
|
1037
|
+
[epub/index.ts:1036](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1036)
|
|
1038
1038
|
|
|
1039
1039
|
Retrieve the publication type from the dc:type element in the EPUB metadata.
|
|
1040
1040
|
|
|
@@ -1055,7 +1055,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
|
|
|
1055
1055
|
> **readItemContents**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
1056
1056
|
|
|
1057
1057
|
Defined in:
|
|
1058
|
-
[epub/index.ts:
|
|
1058
|
+
[epub/index.ts:1989](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1989)
|
|
1059
1059
|
|
|
1060
1060
|
Retrieve the contents of a manifest item, given its id.
|
|
1061
1061
|
|
|
@@ -1078,7 +1078,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
|
|
|
1078
1078
|
> **readItemContents**(`id`, `encoding`): `Promise`\<`string`\>
|
|
1079
1079
|
|
|
1080
1080
|
Defined in:
|
|
1081
|
-
[epub/index.ts:
|
|
1081
|
+
[epub/index.ts:1990](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1990)
|
|
1082
1082
|
|
|
1083
1083
|
Retrieve the contents of a manifest item, given its id.
|
|
1084
1084
|
|
|
@@ -1104,7 +1104,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
|
|
|
1104
1104
|
> **readXhtmlItemContents**(`id`, `as?`): `Promise`\<[`ParsedXml`](#parsedxml)\>
|
|
1105
1105
|
|
|
1106
1106
|
Defined in:
|
|
1107
|
-
[epub/index.ts:
|
|
1107
|
+
[epub/index.ts:2050](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2050)
|
|
1108
1108
|
|
|
1109
1109
|
Retrieves the contents of an XHTML item, given its manifest id.
|
|
1110
1110
|
|
|
@@ -1128,7 +1128,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
|
|
|
1128
1128
|
> **readXhtmlItemContents**(`id`, `as`): `Promise`\<`string`\>
|
|
1129
1129
|
|
|
1130
1130
|
Defined in:
|
|
1131
|
-
[epub/index.ts:
|
|
1131
|
+
[epub/index.ts:2051](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2051)
|
|
1132
1132
|
|
|
1133
1133
|
Retrieves the contents of an XHTML item, given its manifest id.
|
|
1134
1134
|
|
|
@@ -1152,7 +1152,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
|
|
|
1152
1152
|
> **removeCollection**(`index`): `Promise`\<`void`\>
|
|
1153
1153
|
|
|
1154
1154
|
Defined in:
|
|
1155
|
-
[epub/index.ts:
|
|
1155
|
+
[epub/index.ts:1589](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1589)
|
|
1156
1156
|
|
|
1157
1157
|
Remove a collection from the EPUB metadata.
|
|
1158
1158
|
|
|
@@ -1174,7 +1174,7 @@ returned by `epub.getCollections()`.
|
|
|
1174
1174
|
> **removeContributor**(`index`): `Promise`\<`void`\>
|
|
1175
1175
|
|
|
1176
1176
|
Defined in:
|
|
1177
|
-
[epub/index.ts:
|
|
1177
|
+
[epub/index.ts:1846](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1846)
|
|
1178
1178
|
|
|
1179
1179
|
Remove a contributor from the EPUB metadata.
|
|
1180
1180
|
|
|
@@ -1202,7 +1202,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
|
|
|
1202
1202
|
> **removeCreator**(`index`, `type`): `Promise`\<`void`\>
|
|
1203
1203
|
|
|
1204
1204
|
Defined in:
|
|
1205
|
-
[epub/index.ts:
|
|
1205
|
+
[epub/index.ts:1794](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1794)
|
|
1206
1206
|
|
|
1207
1207
|
Remove a creator from the EPUB metadata.
|
|
1208
1208
|
|
|
@@ -1229,7 +1229,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
|
|
|
1229
1229
|
> **removeManifestItem**(`id`): `Promise`\<`void`\>
|
|
1230
1230
|
|
|
1231
1231
|
Defined in:
|
|
1232
|
-
[epub/index.ts:
|
|
1232
|
+
[epub/index.ts:2146](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2146)
|
|
1233
1233
|
|
|
1234
1234
|
##### Parameters
|
|
1235
1235
|
|
|
@@ -1246,7 +1246,7 @@ Defined in:
|
|
|
1246
1246
|
> **removeMetadata**(`predicate`): `Promise`\<`void`\>
|
|
1247
1247
|
|
|
1248
1248
|
Defined in:
|
|
1249
|
-
[epub/index.ts:
|
|
1249
|
+
[epub/index.ts:2395](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2395)
|
|
1250
1250
|
|
|
1251
1251
|
Remove one or more metadata entries.
|
|
1252
1252
|
|
|
@@ -1272,7 +1272,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
|
|
|
1272
1272
|
> **removeSpineItem**(`index`): `Promise`\<`void`\>
|
|
1273
1273
|
|
|
1274
1274
|
Defined in:
|
|
1275
|
-
[epub/index.ts:
|
|
1275
|
+
[epub/index.ts:1952](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1952)
|
|
1276
1276
|
|
|
1277
1277
|
Remove the spine item at the specified index.
|
|
1278
1278
|
|
|
@@ -1295,7 +1295,7 @@ https://www.w3.org/TR/epub-33/#sec-spine-elem
|
|
|
1295
1295
|
> **removeSubject**(`index`): `Promise`\<`void`\>
|
|
1296
1296
|
|
|
1297
1297
|
Defined in:
|
|
1298
|
-
[epub/index.ts:
|
|
1298
|
+
[epub/index.ts:1086](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1086)
|
|
1299
1299
|
|
|
1300
1300
|
Remove a subject from the EPUB metadata.
|
|
1301
1301
|
|
|
@@ -1321,7 +1321,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dccreator
|
|
|
1321
1321
|
> **replaceMetadata**(`predicate`, `entry`): `Promise`\<`void`\>
|
|
1322
1322
|
|
|
1323
1323
|
Defined in:
|
|
1324
|
-
[epub/index.ts:
|
|
1324
|
+
[epub/index.ts:2350](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2350)
|
|
1325
1325
|
|
|
1326
1326
|
Replace a metadata entry with a new one.
|
|
1327
1327
|
|
|
@@ -1348,7 +1348,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-metadata
|
|
|
1348
1348
|
> **saveAndClose**(): `Promise`\<`void`\>
|
|
1349
1349
|
|
|
1350
1350
|
Defined in:
|
|
1351
|
-
[epub/index.ts:
|
|
1351
|
+
[epub/index.ts:2436](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2436)
|
|
1352
1352
|
|
|
1353
1353
|
Write the current contents of the Epub to a new EPUB archive on disk.
|
|
1354
1354
|
|
|
@@ -1364,7 +1364,7 @@ updated to the current UTC timestamp.
|
|
|
1364
1364
|
> **setCoverImage**(`href`, `data`): `Promise`\<`void`\>
|
|
1365
1365
|
|
|
1366
1366
|
Defined in:
|
|
1367
|
-
[epub/index.ts:
|
|
1367
|
+
[epub/index.ts:966](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L966)
|
|
1368
1368
|
|
|
1369
1369
|
Set the cover image for the EPUB.
|
|
1370
1370
|
|
|
@@ -1387,7 +1387,7 @@ then writes the provided image data to the provided href within the publication.
|
|
|
1387
1387
|
> **setDescription**(`description`): `Promise`\<`void`\>
|
|
1388
1388
|
|
|
1389
1389
|
Defined in:
|
|
1390
|
-
[epub/index.ts:
|
|
1390
|
+
[epub/index.ts:1315](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1315)
|
|
1391
1391
|
|
|
1392
1392
|
Update the Epub's description metadata entry.
|
|
1393
1393
|
|
|
@@ -1410,7 +1410,7 @@ encoded as HTML entities.
|
|
|
1410
1410
|
> **setIdentifier**(`identifier`): `Promise`\<`void`\>
|
|
1411
1411
|
|
|
1412
1412
|
Defined in:
|
|
1413
|
-
[epub/index.ts:
|
|
1413
|
+
[epub/index.ts:881](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L881)
|
|
1414
1414
|
|
|
1415
1415
|
Set the dc:identifier metadata element with the provided string.
|
|
1416
1416
|
|
|
@@ -1436,7 +1436,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcidentifier
|
|
|
1436
1436
|
> **setLanguage**(`locale`): `Promise`\<`void`\>
|
|
1437
1437
|
|
|
1438
1438
|
Defined in:
|
|
1439
|
-
[epub/index.ts:
|
|
1439
|
+
[epub/index.ts:1197](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1197)
|
|
1440
1440
|
|
|
1441
1441
|
Update the Epub's language metadata entry.
|
|
1442
1442
|
|
|
@@ -1462,7 +1462,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dclanguage
|
|
|
1462
1462
|
> **setPackageVocabularyPrefix**(`prefix`, `uri`): `Promise`\<`void`\>
|
|
1463
1463
|
|
|
1464
1464
|
Defined in:
|
|
1465
|
-
[epub/index.ts:
|
|
1465
|
+
[epub/index.ts:1366](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1366)
|
|
1466
1466
|
|
|
1467
1467
|
Set a custom vocabulary prefix on the root package element.
|
|
1468
1468
|
|
|
@@ -1486,7 +1486,7 @@ https://www.w3.org/TR/epub-33/#sec-prefix-attr
|
|
|
1486
1486
|
> **setPublicationDate**(`date`): `Promise`\<`void`\>
|
|
1487
1487
|
|
|
1488
1488
|
Defined in:
|
|
1489
|
-
[epub/index.ts:
|
|
1489
|
+
[epub/index.ts:1004](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1004)
|
|
1490
1490
|
|
|
1491
1491
|
Set the dc:date metadata element with the provided date.
|
|
1492
1492
|
|
|
@@ -1512,7 +1512,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dcdate
|
|
|
1512
1512
|
> **setTitle**(`title`): `Promise`\<`void`\>
|
|
1513
1513
|
|
|
1514
1514
|
Defined in:
|
|
1515
|
-
[epub/index.ts:
|
|
1515
|
+
[epub/index.ts:1390](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1390)
|
|
1516
1516
|
|
|
1517
1517
|
Set the title of the Epub.
|
|
1518
1518
|
|
|
@@ -1540,7 +1540,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctitle
|
|
|
1540
1540
|
> **setTitles**(`entries`): `Promise`\<`void`\>
|
|
1541
1541
|
|
|
1542
1542
|
Defined in:
|
|
1543
|
-
[epub/index.ts:
|
|
1543
|
+
[epub/index.ts:1418](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1418)
|
|
1544
1544
|
|
|
1545
1545
|
##### Parameters
|
|
1546
1546
|
|
|
@@ -1557,7 +1557,7 @@ Defined in:
|
|
|
1557
1557
|
> **setType**(`type`): `Promise`\<`void`\>
|
|
1558
1558
|
|
|
1559
1559
|
Defined in:
|
|
1560
|
-
[epub/index.ts:
|
|
1560
|
+
[epub/index.ts:1020](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L1020)
|
|
1561
1561
|
|
|
1562
1562
|
Set the dc:type metadata element.
|
|
1563
1563
|
|
|
@@ -1583,7 +1583,7 @@ https://www.w3.org/TR/epub-33/#sec-opf-dctype
|
|
|
1583
1583
|
> **updateManifestItem**(`id`, `newItem`): `Promise`\<`void`\>
|
|
1584
1584
|
|
|
1585
1585
|
Defined in:
|
|
1586
|
-
[epub/index.ts:
|
|
1586
|
+
[epub/index.ts:2262](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2262)
|
|
1587
1587
|
|
|
1588
1588
|
Update the manifest entry for an existing item.
|
|
1589
1589
|
|
|
@@ -1612,7 +1612,7 @@ https://www.w3.org/TR/epub-33/#sec-pkg-manifest
|
|
|
1612
1612
|
> **writeItemContents**(`id`, `contents`): `Promise`\<`void`\>
|
|
1613
1613
|
|
|
1614
1614
|
Defined in:
|
|
1615
|
-
[epub/index.ts:
|
|
1615
|
+
[epub/index.ts:2098](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2098)
|
|
1616
1616
|
|
|
1617
1617
|
Write new contents for an existing manifest item, specified by its id.
|
|
1618
1618
|
|
|
@@ -1639,7 +1639,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
|
|
|
1639
1639
|
> **writeItemContents**(`id`, `contents`, `encoding`): `Promise`\<`void`\>
|
|
1640
1640
|
|
|
1641
1641
|
Defined in:
|
|
1642
|
-
[epub/index.ts:
|
|
1642
|
+
[epub/index.ts:2099](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2099)
|
|
1643
1643
|
|
|
1644
1644
|
Write new contents for an existing manifest item, specified by its id.
|
|
1645
1645
|
|
|
@@ -1667,7 +1667,7 @@ https://www.w3.org/TR/epub-33/#sec-contentdocs
|
|
|
1667
1667
|
> **writeXhtmlItemContents**(`id`, `contents`): `Promise`\<`void`\>
|
|
1668
1668
|
|
|
1669
1669
|
Defined in:
|
|
1670
|
-
[epub/index.ts:
|
|
1670
|
+
[epub/index.ts:2138](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L2138)
|
|
1671
1671
|
|
|
1672
1672
|
Write new contents for an existing XHTML item, specified by its id.
|
|
1673
1673
|
|
|
@@ -1694,7 +1694,7 @@ https://www.w3.org/TR/epub-33/#sec-xhtml
|
|
|
1694
1694
|
> `static` **addLinkToXhtmlHead**(`xml`, `link`): `void`
|
|
1695
1695
|
|
|
1696
1696
|
Defined in:
|
|
1697
|
-
[epub/index.ts:
|
|
1697
|
+
[epub/index.ts:245](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L245)
|
|
1698
1698
|
|
|
1699
1699
|
Given an XML structure representing a complete XHTML document, add a `link`
|
|
1700
1700
|
element to the `head` of the document.
|
|
@@ -1721,7 +1721,7 @@ This method modifies the provided XML structure.
|
|
|
1721
1721
|
> `Promise`\<[`Epub`](#epub)\>
|
|
1722
1722
|
|
|
1723
1723
|
Defined in:
|
|
1724
|
-
[epub/index.ts:
|
|
1724
|
+
[epub/index.ts:399](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L399)
|
|
1725
1725
|
|
|
1726
1726
|
Construct an Epub instance, optionally beginning with the provided metadata.
|
|
1727
1727
|
|
|
@@ -1743,7 +1743,7 @@ Construct an Epub instance, optionally beginning with the provided metadata.
|
|
|
1743
1743
|
> [`XmlElement`](#xmlelement)\<`Name`\>
|
|
1744
1744
|
|
|
1745
1745
|
Defined in:
|
|
1746
|
-
[epub/index.ts:
|
|
1746
|
+
[epub/index.ts:280](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L280)
|
|
1747
1747
|
|
|
1748
1748
|
##### Type Parameters
|
|
1749
1749
|
|
|
@@ -1768,7 +1768,7 @@ Defined in:
|
|
|
1768
1768
|
> `static` **createXmlTextNode**(`text`): [`XmlTextNode`](#xmltextnode)
|
|
1769
1769
|
|
|
1770
1770
|
Defined in:
|
|
1771
|
-
[epub/index.ts:
|
|
1771
|
+
[epub/index.ts:293](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L293)
|
|
1772
1772
|
|
|
1773
1773
|
##### Parameters
|
|
1774
1774
|
|
|
@@ -1786,7 +1786,7 @@ Defined in:
|
|
|
1786
1786
|
> `undefined` \| [`XmlElement`](#xmlelement)\<`Name`\>
|
|
1787
1787
|
|
|
1788
1788
|
Defined in:
|
|
1789
|
-
[epub/index.ts:
|
|
1789
|
+
[epub/index.ts:354](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L354)
|
|
1790
1790
|
|
|
1791
1791
|
Given an XML structure, find the first child matching the provided name and
|
|
1792
1792
|
optional filter.
|
|
@@ -1814,7 +1814,7 @@ optional filter.
|
|
|
1814
1814
|
> `static` **formatSmilDuration**(`duration`): `string`
|
|
1815
1815
|
|
|
1816
1816
|
Defined in:
|
|
1817
|
-
[epub/index.ts:
|
|
1817
|
+
[epub/index.ts:228](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L228)
|
|
1818
1818
|
|
|
1819
1819
|
Format a duration, provided as a number of seconds, as a SMIL clock value, to be
|
|
1820
1820
|
used for Media Overlays.
|
|
@@ -1838,7 +1838,7 @@ https://www.w3.org/TR/epub-33/#sec-duration
|
|
|
1838
1838
|
> `static` **from**(`pathOrData`): `Promise`\<[`Epub`](#epub)\>
|
|
1839
1839
|
|
|
1840
1840
|
Defined in:
|
|
1841
|
-
[epub/index.ts:
|
|
1841
|
+
[epub/index.ts:483](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L483)
|
|
1842
1842
|
|
|
1843
1843
|
Construct an Epub instance by reading an existing EPUB publication.
|
|
1844
1844
|
|
|
@@ -1857,7 +1857,7 @@ Construct an Epub instance by reading an existing EPUB publication.
|
|
|
1857
1857
|
> `static` **getXhtmlBody**(`xml`): [`ParsedXml`](#parsedxml)
|
|
1858
1858
|
|
|
1859
1859
|
Defined in:
|
|
1860
|
-
[epub/index.ts:
|
|
1860
|
+
[epub/index.ts:270](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L270)
|
|
1861
1861
|
|
|
1862
1862
|
Given an XML structure representing a complete XHTML document, return the
|
|
1863
1863
|
sub-structure representing the children of the document's body element.
|
|
@@ -1877,7 +1877,7 @@ sub-structure representing the children of the document's body element.
|
|
|
1877
1877
|
> `static` **getXhtmlTextContent**(`xml`): `string`
|
|
1878
1878
|
|
|
1879
1879
|
Defined in:
|
|
1880
|
-
[epub/index.ts:
|
|
1880
|
+
[epub/index.ts:302](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L302)
|
|
1881
1881
|
|
|
1882
1882
|
Given an XML structure representing a complete XHTML document, return a string
|
|
1883
1883
|
representing the concatenation of all text nodes in the document.
|
|
@@ -1897,7 +1897,7 @@ representing the concatenation of all text nodes in the document.
|
|
|
1897
1897
|
> `static` **getXmlChildren**\<`Name`\>(`element`): [`ParsedXml`](#parsedxml)
|
|
1898
1898
|
|
|
1899
1899
|
Defined in:
|
|
1900
|
-
[epub/index.ts:
|
|
1900
|
+
[epub/index.ts:334](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L334)
|
|
1901
1901
|
|
|
1902
1902
|
Given an XMLElement, return a list of its children
|
|
1903
1903
|
|
|
@@ -1922,7 +1922,7 @@ Given an XMLElement, return a list of its children
|
|
|
1922
1922
|
> `static` **getXmlElementName**\<`Name`\>(`element`): `Name`
|
|
1923
1923
|
|
|
1924
1924
|
Defined in:
|
|
1925
|
-
[epub/index.ts:
|
|
1925
|
+
[epub/index.ts:319](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L319)
|
|
1926
1926
|
|
|
1927
1927
|
Given an XMLElement, return its tag name.
|
|
1928
1928
|
|
|
@@ -1947,7 +1947,7 @@ Given an XMLElement, return its tag name.
|
|
|
1947
1947
|
> `static` **isXmlTextNode**(`node`): `node is XmlTextNode`
|
|
1948
1948
|
|
|
1949
1949
|
Defined in:
|
|
1950
|
-
[epub/index.ts:
|
|
1950
|
+
[epub/index.ts:367](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L367)
|
|
1951
1951
|
|
|
1952
1952
|
Given an XMLNode, determine whether it represents a text node or an XML element.
|
|
1953
1953
|
|
|
@@ -1966,7 +1966,7 @@ Given an XMLNode, determine whether it represents a text node or an XML element.
|
|
|
1966
1966
|
> `static` **replaceXmlChildren**\<`Name`\>(`element`, `children`): `void`
|
|
1967
1967
|
|
|
1968
1968
|
Defined in:
|
|
1969
|
-
[epub/index.ts:
|
|
1969
|
+
[epub/index.ts:342](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L342)
|
|
1970
1970
|
|
|
1971
1971
|
##### Type Parameters
|
|
1972
1972
|
|
|
@@ -1990,7 +1990,7 @@ Defined in:
|
|
|
1990
1990
|
## AlternateScript
|
|
1991
1991
|
|
|
1992
1992
|
Defined in:
|
|
1993
|
-
[epub/index.ts:
|
|
1993
|
+
[epub/index.ts:108](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L108)
|
|
1994
1994
|
|
|
1995
1995
|
### Properties
|
|
1996
1996
|
|
|
@@ -1999,21 +1999,21 @@ Defined in:
|
|
|
1999
1999
|
> **locale**: `Locale`
|
|
2000
2000
|
|
|
2001
2001
|
Defined in:
|
|
2002
|
-
[epub/index.ts:
|
|
2002
|
+
[epub/index.ts:110](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L110)
|
|
2003
2003
|
|
|
2004
2004
|
#### name
|
|
2005
2005
|
|
|
2006
2006
|
> **name**: `string`
|
|
2007
2007
|
|
|
2008
2008
|
Defined in:
|
|
2009
|
-
[epub/index.ts:
|
|
2009
|
+
[epub/index.ts:109](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L109)
|
|
2010
2010
|
|
|
2011
2011
|
---
|
|
2012
2012
|
|
|
2013
2013
|
## Collection
|
|
2014
2014
|
|
|
2015
2015
|
Defined in:
|
|
2016
|
-
[epub/index.ts:
|
|
2016
|
+
[epub/index.ts:132](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L132)
|
|
2017
2017
|
|
|
2018
2018
|
### Properties
|
|
2019
2019
|
|
|
@@ -2022,28 +2022,28 @@ Defined in:
|
|
|
2022
2022
|
> **name**: `string`
|
|
2023
2023
|
|
|
2024
2024
|
Defined in:
|
|
2025
|
-
[epub/index.ts:
|
|
2025
|
+
[epub/index.ts:133](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L133)
|
|
2026
2026
|
|
|
2027
2027
|
#### position?
|
|
2028
2028
|
|
|
2029
2029
|
> `optional` **position**: `string`
|
|
2030
2030
|
|
|
2031
2031
|
Defined in:
|
|
2032
|
-
[epub/index.ts:
|
|
2032
|
+
[epub/index.ts:135](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L135)
|
|
2033
2033
|
|
|
2034
2034
|
#### type?
|
|
2035
2035
|
|
|
2036
2036
|
> `optional` **type**: `string`
|
|
2037
2037
|
|
|
2038
2038
|
Defined in:
|
|
2039
|
-
[epub/index.ts:
|
|
2039
|
+
[epub/index.ts:134](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L134)
|
|
2040
2040
|
|
|
2041
2041
|
---
|
|
2042
2042
|
|
|
2043
2043
|
## DcCreator
|
|
2044
2044
|
|
|
2045
2045
|
Defined in:
|
|
2046
|
-
[epub/index.ts:
|
|
2046
|
+
[epub/index.ts:113](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L113)
|
|
2047
2047
|
|
|
2048
2048
|
### Properties
|
|
2049
2049
|
|
|
@@ -2052,42 +2052,42 @@ Defined in:
|
|
|
2052
2052
|
> `optional` **alternateScripts**: [`AlternateScript`](#alternatescript)[]
|
|
2053
2053
|
|
|
2054
2054
|
Defined in:
|
|
2055
|
-
[epub/index.ts:
|
|
2055
|
+
[epub/index.ts:118](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L118)
|
|
2056
2056
|
|
|
2057
2057
|
#### fileAs?
|
|
2058
2058
|
|
|
2059
2059
|
> `optional` **fileAs**: `string`
|
|
2060
2060
|
|
|
2061
2061
|
Defined in:
|
|
2062
|
-
[epub/index.ts:
|
|
2062
|
+
[epub/index.ts:117](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L117)
|
|
2063
2063
|
|
|
2064
2064
|
#### name
|
|
2065
2065
|
|
|
2066
2066
|
> **name**: `string`
|
|
2067
2067
|
|
|
2068
2068
|
Defined in:
|
|
2069
|
-
[epub/index.ts:
|
|
2069
|
+
[epub/index.ts:114](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L114)
|
|
2070
2070
|
|
|
2071
2071
|
#### role?
|
|
2072
2072
|
|
|
2073
2073
|
> `optional` **role**: `string`
|
|
2074
2074
|
|
|
2075
2075
|
Defined in:
|
|
2076
|
-
[epub/index.ts:
|
|
2076
|
+
[epub/index.ts:115](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L115)
|
|
2077
2077
|
|
|
2078
2078
|
#### roleScheme?
|
|
2079
2079
|
|
|
2080
2080
|
> `optional` **roleScheme**: `string`
|
|
2081
2081
|
|
|
2082
2082
|
Defined in:
|
|
2083
|
-
[epub/index.ts:
|
|
2083
|
+
[epub/index.ts:116](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L116)
|
|
2084
2084
|
|
|
2085
2085
|
---
|
|
2086
2086
|
|
|
2087
2087
|
## DcSubject
|
|
2088
2088
|
|
|
2089
2089
|
Defined in:
|
|
2090
|
-
[epub/index.ts:
|
|
2090
|
+
[epub/index.ts:102](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L102)
|
|
2091
2091
|
|
|
2092
2092
|
### Properties
|
|
2093
2093
|
|
|
@@ -2096,28 +2096,28 @@ Defined in:
|
|
|
2096
2096
|
> **authority**: `string`
|
|
2097
2097
|
|
|
2098
2098
|
Defined in:
|
|
2099
|
-
[epub/index.ts:
|
|
2099
|
+
[epub/index.ts:104](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L104)
|
|
2100
2100
|
|
|
2101
2101
|
#### term
|
|
2102
2102
|
|
|
2103
2103
|
> **term**: `string`
|
|
2104
2104
|
|
|
2105
2105
|
Defined in:
|
|
2106
|
-
[epub/index.ts:
|
|
2106
|
+
[epub/index.ts:105](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L105)
|
|
2107
2107
|
|
|
2108
2108
|
#### value
|
|
2109
2109
|
|
|
2110
2110
|
> **value**: `string`
|
|
2111
2111
|
|
|
2112
2112
|
Defined in:
|
|
2113
|
-
[epub/index.ts:
|
|
2113
|
+
[epub/index.ts:103](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L103)
|
|
2114
2114
|
|
|
2115
2115
|
---
|
|
2116
2116
|
|
|
2117
2117
|
## DublinCore
|
|
2118
2118
|
|
|
2119
2119
|
Defined in:
|
|
2120
|
-
[epub/index.ts:
|
|
2120
|
+
[epub/index.ts:121](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L121)
|
|
2121
2121
|
|
|
2122
2122
|
### Properties
|
|
2123
2123
|
|
|
@@ -2126,56 +2126,56 @@ Defined in:
|
|
|
2126
2126
|
> `optional` **contributors**: [`DcCreator`](#dccreator)[]
|
|
2127
2127
|
|
|
2128
2128
|
Defined in:
|
|
2129
|
-
[epub/index.ts:
|
|
2129
|
+
[epub/index.ts:128](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L128)
|
|
2130
2130
|
|
|
2131
2131
|
#### creators?
|
|
2132
2132
|
|
|
2133
2133
|
> `optional` **creators**: [`DcCreator`](#dccreator)[]
|
|
2134
2134
|
|
|
2135
2135
|
Defined in:
|
|
2136
|
-
[epub/index.ts:
|
|
2136
|
+
[epub/index.ts:127](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L127)
|
|
2137
2137
|
|
|
2138
2138
|
#### date?
|
|
2139
2139
|
|
|
2140
2140
|
> `optional` **date**: `Date`
|
|
2141
2141
|
|
|
2142
2142
|
Defined in:
|
|
2143
|
-
[epub/index.ts:
|
|
2143
|
+
[epub/index.ts:125](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L125)
|
|
2144
2144
|
|
|
2145
2145
|
#### identifier
|
|
2146
2146
|
|
|
2147
2147
|
> **identifier**: `string`
|
|
2148
2148
|
|
|
2149
2149
|
Defined in:
|
|
2150
|
-
[epub/index.ts:
|
|
2150
|
+
[epub/index.ts:124](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L124)
|
|
2151
2151
|
|
|
2152
2152
|
#### language
|
|
2153
2153
|
|
|
2154
2154
|
> **language**: `Locale`
|
|
2155
2155
|
|
|
2156
2156
|
Defined in:
|
|
2157
|
-
[epub/index.ts:
|
|
2157
|
+
[epub/index.ts:123](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L123)
|
|
2158
2158
|
|
|
2159
2159
|
#### subjects?
|
|
2160
2160
|
|
|
2161
2161
|
> `optional` **subjects**: (`string` \| [`DcSubject`](#dcsubject))[]
|
|
2162
2162
|
|
|
2163
2163
|
Defined in:
|
|
2164
|
-
[epub/index.ts:
|
|
2164
|
+
[epub/index.ts:126](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L126)
|
|
2165
2165
|
|
|
2166
2166
|
#### title
|
|
2167
2167
|
|
|
2168
2168
|
> **title**: `string`
|
|
2169
2169
|
|
|
2170
2170
|
Defined in:
|
|
2171
|
-
[epub/index.ts:
|
|
2171
|
+
[epub/index.ts:122](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L122)
|
|
2172
2172
|
|
|
2173
2173
|
#### type?
|
|
2174
2174
|
|
|
2175
2175
|
> `optional` **type**: `string`
|
|
2176
2176
|
|
|
2177
2177
|
Defined in:
|
|
2178
|
-
[epub/index.ts:
|
|
2178
|
+
[epub/index.ts:129](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L129)
|
|
2179
2179
|
|
|
2180
2180
|
---
|
|
2181
2181
|
|
|
@@ -2185,7 +2185,7 @@ Defined in:
|
|
|
2185
2185
|
> \`$\{Letter \| Uppercase\<Letter\> \| QuestionMark\}$\{string\}\`
|
|
2186
2186
|
|
|
2187
2187
|
Defined in:
|
|
2188
|
-
[epub/index.ts:
|
|
2188
|
+
[epub/index.ts:63](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L63)
|
|
2189
2189
|
|
|
2190
2190
|
A valid name for an XML element (must start with a letter)
|
|
2191
2191
|
|
|
@@ -2196,7 +2196,7 @@ A valid name for an XML element (must start with a letter)
|
|
|
2196
2196
|
> **EpubMetadata** = [`MetadataEntry`](#metadataentry)[]
|
|
2197
2197
|
|
|
2198
2198
|
Defined in:
|
|
2199
|
-
[epub/index.ts:
|
|
2199
|
+
[epub/index.ts:100](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L100)
|
|
2200
2200
|
|
|
2201
2201
|
---
|
|
2202
2202
|
|
|
@@ -2205,7 +2205,7 @@ Defined in:
|
|
|
2205
2205
|
> **ManifestItem** = `object`
|
|
2206
2206
|
|
|
2207
2207
|
Defined in:
|
|
2208
|
-
[epub/index.ts:
|
|
2208
|
+
[epub/index.ts:84](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L84)
|
|
2209
2209
|
|
|
2210
2210
|
### Properties
|
|
2211
2211
|
|
|
@@ -2214,42 +2214,42 @@ Defined in:
|
|
|
2214
2214
|
> `optional` **fallback**: `string`
|
|
2215
2215
|
|
|
2216
2216
|
Defined in:
|
|
2217
|
-
[epub/index.ts:
|
|
2217
|
+
[epub/index.ts:88](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L88)
|
|
2218
2218
|
|
|
2219
2219
|
#### href
|
|
2220
2220
|
|
|
2221
2221
|
> **href**: `string`
|
|
2222
2222
|
|
|
2223
2223
|
Defined in:
|
|
2224
|
-
[epub/index.ts:
|
|
2224
|
+
[epub/index.ts:86](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L86)
|
|
2225
2225
|
|
|
2226
2226
|
#### id
|
|
2227
2227
|
|
|
2228
2228
|
> **id**: `string`
|
|
2229
2229
|
|
|
2230
2230
|
Defined in:
|
|
2231
|
-
[epub/index.ts:
|
|
2231
|
+
[epub/index.ts:85](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L85)
|
|
2232
2232
|
|
|
2233
2233
|
#### mediaOverlay?
|
|
2234
2234
|
|
|
2235
2235
|
> `optional` **mediaOverlay**: `string`
|
|
2236
2236
|
|
|
2237
2237
|
Defined in:
|
|
2238
|
-
[epub/index.ts:
|
|
2238
|
+
[epub/index.ts:89](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L89)
|
|
2239
2239
|
|
|
2240
2240
|
#### mediaType?
|
|
2241
2241
|
|
|
2242
2242
|
> `optional` **mediaType**: `string`
|
|
2243
2243
|
|
|
2244
2244
|
Defined in:
|
|
2245
|
-
[epub/index.ts:
|
|
2245
|
+
[epub/index.ts:87](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L87)
|
|
2246
2246
|
|
|
2247
2247
|
#### properties?
|
|
2248
2248
|
|
|
2249
2249
|
> `optional` **properties**: `string`[]
|
|
2250
2250
|
|
|
2251
2251
|
Defined in:
|
|
2252
|
-
[epub/index.ts:
|
|
2252
|
+
[epub/index.ts:90](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L90)
|
|
2253
2253
|
|
|
2254
2254
|
---
|
|
2255
2255
|
|
|
@@ -2258,7 +2258,7 @@ Defined in:
|
|
|
2258
2258
|
> **MetadataEntry** = `object`
|
|
2259
2259
|
|
|
2260
2260
|
Defined in:
|
|
2261
|
-
[epub/index.ts:
|
|
2261
|
+
[epub/index.ts:93](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L93)
|
|
2262
2262
|
|
|
2263
2263
|
### Properties
|
|
2264
2264
|
|
|
@@ -2267,28 +2267,28 @@ Defined in:
|
|
|
2267
2267
|
> `optional` **id**: `string`
|
|
2268
2268
|
|
|
2269
2269
|
Defined in:
|
|
2270
|
-
[epub/index.ts:
|
|
2270
|
+
[epub/index.ts:94](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L94)
|
|
2271
2271
|
|
|
2272
2272
|
#### properties
|
|
2273
2273
|
|
|
2274
2274
|
> **properties**: `Record`\<`string`, `string`\>
|
|
2275
2275
|
|
|
2276
2276
|
Defined in:
|
|
2277
|
-
[epub/index.ts:
|
|
2277
|
+
[epub/index.ts:96](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L96)
|
|
2278
2278
|
|
|
2279
2279
|
#### type
|
|
2280
2280
|
|
|
2281
2281
|
> **type**: [`ElementName`](#elementname)
|
|
2282
2282
|
|
|
2283
2283
|
Defined in:
|
|
2284
|
-
[epub/index.ts:
|
|
2284
|
+
[epub/index.ts:95](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L95)
|
|
2285
2285
|
|
|
2286
2286
|
#### value
|
|
2287
2287
|
|
|
2288
2288
|
> **value**: `string` \| `undefined`
|
|
2289
2289
|
|
|
2290
2290
|
Defined in:
|
|
2291
|
-
[epub/index.ts:
|
|
2291
|
+
[epub/index.ts:97](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L97)
|
|
2292
2292
|
|
|
2293
2293
|
---
|
|
2294
2294
|
|
|
@@ -2298,7 +2298,7 @@ Defined in:
|
|
|
2298
2298
|
> [`XmlElement`](#xmlelement)\<`"opf:package"`\>
|
|
2299
2299
|
|
|
2300
2300
|
Defined in:
|
|
2301
|
-
[epub/index.ts:
|
|
2301
|
+
[epub/index.ts:138](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L138)
|
|
2302
2302
|
|
|
2303
2303
|
---
|
|
2304
2304
|
|
|
@@ -2307,7 +2307,7 @@ Defined in:
|
|
|
2307
2307
|
> **ParsedXml** = [`XmlNode`](#xmlnode)[]
|
|
2308
2308
|
|
|
2309
2309
|
Defined in:
|
|
2310
|
-
[epub/index.ts:
|
|
2310
|
+
[epub/index.ts:82](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L82)
|
|
2311
2311
|
|
|
2312
2312
|
An XML structure
|
|
2313
2313
|
|
|
@@ -2318,7 +2318,7 @@ An XML structure
|
|
|
2318
2318
|
> **XmlElement**\<`Name`\> = `object` & `{ [key in Name]: ParsedXml }`
|
|
2319
2319
|
|
|
2320
2320
|
Defined in:
|
|
2321
|
-
[epub/index.ts:
|
|
2321
|
+
[epub/index.ts:69](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L69)
|
|
2322
2322
|
|
|
2323
2323
|
An XML element
|
|
2324
2324
|
|
|
@@ -2341,7 +2341,7 @@ An XML element
|
|
|
2341
2341
|
> **XmlNode** = [`XmlElement`](#xmlelement) \| [`XmlTextNode`](#xmltextnode)
|
|
2342
2342
|
|
|
2343
2343
|
Defined in:
|
|
2344
|
-
[epub/index.ts:
|
|
2344
|
+
[epub/index.ts:79](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L79)
|
|
2345
2345
|
|
|
2346
2346
|
A valid XML node. May be either an element or a text node.
|
|
2347
2347
|
|
|
@@ -2352,7 +2352,7 @@ A valid XML node. May be either an element or a text node.
|
|
|
2352
2352
|
> **XmlTextNode** = `object`
|
|
2353
2353
|
|
|
2354
2354
|
Defined in:
|
|
2355
|
-
[epub/index.ts:
|
|
2355
|
+
[epub/index.ts:76](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L76)
|
|
2356
2356
|
|
|
2357
2357
|
A text node in an XML document
|
|
2358
2358
|
|
|
@@ -2363,4 +2363,4 @@ A text node in an XML document
|
|
|
2363
2363
|
> **#text**: `string`
|
|
2364
2364
|
|
|
2365
2365
|
Defined in:
|
|
2366
|
-
[epub/index.ts:
|
|
2366
|
+
[epub/index.ts:76](https://gitlab.com/storyteller-platform/storyteller/-/blob/main/epub/index.ts#L76)
|