Options
All
  • Public
  • Public/Protected
  • All
Menu

epubtools

Index

Functions

  • coverage(OPFXML: any): any
  • creators(OPFXML: any, tag: any): any[]
  • description(OPFXML: any): any
  • doMkMetaCommand(configFN: string): Promise<void>
  • doPackageCommand(configFN: string): Promise<void>
  • findManifestInOPF(OPFXML: any): any
  • findMetadataInOPF(OPFXML: any): any
  • findOpfFileName(containerXml: any): any
  • findRootfiles(containerXml: any): any[]
  • From the container.xml file, look for any rootfile elements, returning a descriptive object ({@link RootFileData}) for each.

    Parameters

    • containerXml: any

      The Document of the container.xml file

    Returns any[]

    An array of {@link RootFileData} objects

  • findSpineInOPF(OPFXML: any): any
  • format(OPFXML: any): any
  • identifiers(OPFXML: any): any[]
  • languages(OPFXML: any): any[]
  • makeOpfXml(config: any): Promise<Document>
  • Parameters

    • config: any

    Returns Promise<Document>

  • manifest(config: any, OPFXML: any): Manifest
  • modifiedDate(OPFXML: any): any
  • publicationDate(OPFXML: any): any
  • publisher(OPFXML: any): any
  • readContainerXml(epubDir: string): Promise<ContainerXMLData>
  • Reads the container.xml file from the EPUB directory.

    Parameters

    • epubDir: string

      The path name of the directory

    Returns Promise<ContainerXMLData>

    A simple object ({@link ContainerXMLData}) describing the container.xml data

  • readOPF(epubDir: string, opfName: string): Promise<OPFData>
  • Reads the OPF file from the EPUB, parsing it to an XML Document.

    Parameters

    • epubDir: string

      The directory where the EPUB files are stored

    • opfName: string

      The file name of the OPF file

    Returns Promise<OPFData>

    An object ({@link OPFData}) for the OPF file

  • readOpf(opfFN: any): Promise<Document>
  • Parameters

    • opfFN: any

    Returns Promise<Document>

  • readTocNCX(tocncxFN: any): Promise<Document>
  • Parameters

    • tocncxFN: any

    Returns Promise<Document>

  • readXHTML(epubDir: string, xhtmlName: string): Promise<XHTMLData>
  • Reads the XHTML file, returning an object ({@link XHTMLData}) containing the text which was read, and the parsed XML Document.

    Parameters

    • epubDir: string

      The directory for the EPUB data

    • xhtmlName: string

      The file name for the file to read

    Returns Promise<XHTMLData>

    An object ({@link XHTMLData}) containing data read from the file

  • refines(metadata: any, id: any): any[]
  • Parameters

    • metadata: any
    • id: any

    Returns any[]

  • relation(OPFXML: any): any
  • rights(OPFXML: any): any
  • subjects(OPFXML: any): any[]
  • titles(OPFXML: any): any[]

Generated using TypeDoc