EpubParser | @ridi/content-parser

Hierarchy

Parser
- EpubParser

Index

Constructors

constructor

Accessors

Constructors

constructor

new EpubParser(input: string, cryptoProvider?: CryptoProvider, logLevel?: string): EpubParser

Overrides Parser.constructor
- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:81
Create new EpubParser

throws

{Errors.ENOENT} no such file or directory

throws

{Errors.EINVAL} invalid input

example

new EpubParser('./foo/bar.epub' or './foo/bar');

Parameters
- input: string
  
  file or directory
- Optional cryptoProvider: CryptoProvider
- Optional logLevel: string
Returns EpubParser

Accessors

cryptoProvider

get cryptoProvider(): CryptoProvider

Inherited from ComicParser.cryptoProvider
- Defined in parser-core/type/Parser.d.ts:106
Get en/decrypto provider

Returns CryptoProvider

input

get input(): string

Inherited from ComicParser.input
- Defined in parser-core/type/Parser.d.ts:101
Get file or directory

Returns string

logger

get logger(): Logger

Inherited from ComicParser.logger
- Defined in parser-core/type/Parser.d.ts:111
Get logger

Returns Logger

onProgress

get onProgress(): (step: number, totalStep: number, action: string) => void
set onProgress(arg: (step: number, totalStep: number, action: string) => void): any

Inherited from ComicParser.onProgress
- Defined in parser-core/type/Parser.d.ts:126
Get onProgress callback

Returns (step: number, totalStep: number, action: string) => void
- - (step: number, totalStep: number, action: string): void
  - Parameters
    - step: number
    - totalStep: number
    - action: string
    Returns void
Inherited from ComicParser.onProgress
- Defined in parser-core/type/Parser.d.ts:121
Set callback that tells progress of parse and readItems.

example

parser.onProgress = (step, totalStep, action) => { console.log([${action}] ${step} / ${totalStep}); }

see

Parser.Action

Parameters
- arg: (step: number, totalStep: number, action: string) => void
  - - (step: number, totalStep: number, action: string): void
    - Parameters
      - step: number
      - totalStep: number
      - action: string
      Returns void
Returns any

Static parseDefaultOptions

get parseDefaultOptions(): { additionalInlineStyle: any; allowNcxFileMissing: boolean; overwrite: boolean; parseStyle: boolean; styleNamespacePrefix: string; unzipPath: string; validatePackage: boolean }

Overrides Parser.parseDefaultOptions
- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:6
Get default values of parse options

Returns { additionalInlineStyle: any; allowNcxFileMissing: boolean; overwrite: boolean; parseStyle: boolean; styleNamespacePrefix: string; unzipPath: string; validatePackage: boolean }
- additionalInlineStyle: any
- allowNcxFileMissing: boolean
- overwrite: boolean
- parseStyle: boolean
- styleNamespacePrefix: string
- unzipPath: string
- validatePackage: boolean

Static parseOptionTypes

get parseOptionTypes(): { additionalInlineStyle: string; allowNcxFileMissing: string; overwrite: string; parseStyle: string; styleNamespacePrefix: string; unzipPath: string; validatePackage: string }

Overrides Parser.parseOptionTypes
- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:18
Get types of parse options

Returns { additionalInlineStyle: string; allowNcxFileMissing: string; overwrite: string; parseStyle: string; styleNamespacePrefix: string; unzipPath: string; validatePackage: string }
- additionalInlineStyle: string
- allowNcxFileMissing: string
- overwrite: string
- parseStyle: string
- styleNamespacePrefix: string
- unzipPath: string
- validatePackage: string

Static readDefaultOptions

get readDefaultOptions(): { force: boolean } & { basePath: string; extractBody: boolean; ignoreScript: boolean; removeAtrules: string[]; removeClassSelector: string[]; removeIdSelector: string[]; removeTagSelector: string[]; serializedAnchor: boolean }

Overrides Parser.readDefaultOptions
- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:44
Get default values of read options

Returns { force: boolean } & { basePath: string; extractBody: boolean; ignoreScript: boolean; removeAtrules: string[]; removeClassSelector: string[]; removeIdSelector: string[]; removeTagSelector: string[]; serializedAnchor: boolean }

Static readOptionTypes

get readOptionTypes(): { force: string } & { basePath: string; extractBody: string; ignoreScript: string; removeAtrules: string; removeClassSelector: string; removeIdSelector: string; removeTagSelector: string; serializedAnchor: string }

Overrides Parser.readOptionTypes
- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:72
Get types of read option

Returns { force: string } & { basePath: string; extractBody: string; ignoreScript: string; removeAtrules: string; removeClassSelector: string; removeIdSelector: string; removeTagSelector: string; serializedAnchor: string }

Methods

_checkResult

_checkResult(book: EpubBook): EpubBook

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:180
Parameters
- book: EpubBook
Returns EpubBook

Protected _createBook

_createBook(context: BaseParseContext): Promise<BaseBook>

Inherited from ComicParser._createBook
- Defined in parser-core/type/Parser.d.ts:200
Create new Book from context

Parameters
- context: BaseParseContext
  
  intermediate result
Returns Promise<BaseBook>

return Book

Protected _getBookClass

_getBookClass(): {}

Inherited from ComicParser._getBookClass
- Defined in parser-core/type/Parser.d.ts:138
virtual

Returns {}

Protected _getParseContextClass

_getParseContextClass(): {}

Inherited from ComicParser._getParseContextClass
- Defined in parser-core/type/Parser.d.ts:132
virtual

Returns {}

Protected _getReadContextClass

_getReadContextClass(): {}

Inherited from ComicParser._getReadContextClass
- Defined in parser-core/type/Parser.d.ts:144
virtual

Returns {}

Protected _getReadItemClass

_getReadItemClass(): {}

Inherited from ComicParser._getReadItemClass
- Defined in parser-core/type/Parser.d.ts:150
virtual

Returns {}

Protected _parseAfterTasks

_parseAfterTasks(): Task[]

Inherited from ComicParser._parseAfterTasks
- Defined in parser-core/type/Parser.d.ts:165
Returns Task[]

return after tasks

Protected _parseBeforeTasks

_parseBeforeTasks(): Task[]

Inherited from ComicParser._parseBeforeTasks
- Defined in parser-core/type/Parser.d.ts:155
Returns Task[]

return before tasks

_parseGuide

_parseGuide(guide: object, context: EpubParseContext): Promise<EpubParseContext>

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:165
Guide parsing in OPF

Parameters
- guide: object
  
  guide AST
- context: EpubParseContext
  
  intermediate result
Returns Promise<EpubParseContext>

return Context containing guide

_parseManifestAndSpine

_parseManifestAndSpine(manifest: object, spine: object, context: EpubParseContext): Promise<EpubParseContext>

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:135
Manifest and spine parsing in OPF

see

EpubParser.parseDefaultOptions.parseStyle

see

EpubParser.parseDefaultOptions.styleNamespacePrefix

Parameters
- manifest: object
  
  manifest AST
- spine: object
  
  spine AST
- context: EpubParseContext
  
  intermediate result
Returns Promise<EpubParseContext>

return Context containing manifest and spine

_parseMetaInf

_parseMetaInf(context: EpubParseContext): Promise<EpubParseContext>

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:109
Locate OPF and base path in container.xml

throws

{Errors.ENOFILE} container.xml not found

throws

{Errors.EINVAL} invalid XML

throws

{Errors.ENOELMT} no such element in container.xml

throws

{Errors.ENOATTR} no such attribute in element

Parameters
- context: EpubParseContext
  
  intermediate result
Returns Promise<EpubParseContext>

return Context containing OPF and base path

_parseMetadata

_parseMetadata(metadata: object, context: EpubParseContext): Promise<EpubParseContext>

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:125
Metadata parsing in OPF

Parameters
- metadata: object
  
  metadata AST
- context: EpubParseContext
  
  intermediate result
Returns Promise<EpubParseContext>

return Context containing metadata

_parseNcx

_parseNcx(context: EpubParseContext): Promise<EpubParseContext>

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:176
NCX parsing

throws

{Errors.EINVAL} invalid XML

throws

{Errors.EINVAL} can not found ncx attribute OPF

throws

{Errors.ENOFILE} NCX not found

throws

{Errors.ENOELMT} no such element in NCX

see

EpubParser.parseDefaultOptions.allowNcxFileMissing

Parameters
- context: EpubParseContext
  
  intermediate result
Returns Promise<EpubParseContext>

return Context containing ncx if exists

_parseOpf

_parseOpf(context: EpubParseContext): Promise<EpubParseContext>

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:118
OPF parsing

throws

{Errors.EINVAL} invalid xml

throws

{Errors.ENOFILE} OPF not found

throws

{Errors.ENOELMT} no such element in OPF

Parameters
- context: EpubParseContext
  
  intermediate result
Returns Promise<EpubParseContext>

return Context containing OPF parsing result

_parseSpineStyle

_parseSpineStyle(rawItem: object, entry: object, options: object): { inlineStyles: object[]; styles: string[] }

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:149
see

EpubParser.parseDefaultOptions.styleNamespacePrefix

see

EpubParser.parseDefaultOptions.additionalInlineStyle

Parameters
- rawItem: object
- entry: object
  
  spine entry
- options: object
  
  parse options
Returns { inlineStyles: object[]; styles: string[] }

returns styles and inline style from spine
- inlineStyles: object[]
  
  inline styles included in Spine
- styles: string[]
  
  path of styles linked to spine

Protected _parseTasks

_parseTasks(): Task[]

Inherited from ComicParser._parseTasks
- Defined in parser-core/type/Parser.d.ts:160
Returns Task[]

return tasks

_prepareParse

_prepareParse(options?: BaseParserOption): Promise<BaseParseContext>

Inherited from ComicParser._prepareParse
- Defined in parser-core/type/Parser.d.ts:184
Validate parse options and get entries from input

async

throws

{Errors.EINVAL} invalid options or value type

throws

{Errors.ENOENT} no such file or directory

throws

{Errors.ENOFILE} no such file

Parameters
- Optional options: BaseParserOption
Returns Promise<BaseParseContext>

return Context containing parse options, entries

_prepareRead

_prepareRead(items: any[], options?: BaseReadOption): Promise<BaseReadContext>

Inherited from ComicParser._prepareRead
- Defined in parser-core/type/Parser.d.ts:245
Validate read options and get entries from input

async

throws

{Errors.EINVAL} invalid options or value type

throws

{Errors.ENOENT} no such file or directory

throws

{Errors.ENOFILE} no such file

Parameters
- items: any[]
  
  targets
- Optional options: BaseReadOption
Returns Promise<BaseReadContext>

returns Context containing target items, read options, entries

_read

_read(context: any): Promise<Array<string | Buffer>>

Inherited from ComicParser._read
- Defined in parser-core/type/Parser.d.ts:255
Contents is read using loader suitable for context

async

override

throws

{Errors.ENOFILE} no such file

see

Parser.readDefaultOptions.force

Parameters
- context: any
  
  properties required for reading
Returns Promise<Array<string | Buffer>>

reading results

Protected _readAfterTasks

_readAfterTasks(): Task[]

Inherited from ComicParser._readAfterTasks
- Defined in parser-core/type/Parser.d.ts:215
Returns Task[]

return after tasks

Protected _readBeforeTasks

_readBeforeTasks(): Task[]

Inherited from ComicParser._readBeforeTasks
- Defined in parser-core/type/Parser.d.ts:205
Returns Task[]

return before tasks

Protected _readTasks

_readTasks(): Task[]

Inherited from ComicParser._readTasks
- Defined in parser-core/type/Parser.d.ts:210
Returns Task[]

return tasks

_unzipIfNeeded

_unzipIfNeeded(context: BaseParseContext): Promise<BaseParseContext>

Inherited from ComicParser._unzipIfNeeded
- Defined in parser-core/type/Parser.d.ts:193
Unzipping if zip source and unzipPath option specified

async

throws

{Errors.ENOENT} no such file or directory

throws

{Errors.EEXIST} file or directory already exists

Parameters
- context: BaseParseContext
  
  intermediate result
Returns Promise<BaseParseContext>

return Context (no change at this step)

_validatePackageIfNeeded

_validatePackageIfNeeded(context: EpubParseContext): Promise<EpubParseContext>

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:99
Validate package spec if zip source and validatePackage option specified

throws

{Errors.EINVAL} invalid package

see

EpubParser.parseDefaultOptions.validatePackage

Parameters
- context: EpubParseContext
  
  intermediate result
Returns Promise<EpubParseContext>

return Context (no change at this step)

getItemTypeFromMediaType

getItemTypeFromMediaType(mediaType: string): FontItem | NcxItem | SpineItem | CssItem | ImageItem | SvgItem | DeadItem

- Defined in content-parser/node_modules/@ridi/epub-parser/type/EpubParser.d.ts:185
Parameters
- mediaType: string
Returns FontItem | NcxItem | SpineItem | CssItem | ImageItem | SvgItem | DeadItem

item type by media-type

parse

parse(options?: BaseParserOption): Promise<BaseBook>

Inherited from ComicParser.parse
- Defined in parser-core/type/Parser.d.ts:174
Parse the input

async

see

Parser.parseDefaultOptions

see

Parser.parseOptionTypes

Parameters
- Optional options: BaseParserOption
Returns Promise<BaseBook>

return Book

readItem

readItem(item: BaseItem, options?: BaseReadOption): string | Buffer

Inherited from ComicParser.readItem
- Defined in parser-core/type/Parser.d.ts:224
Reading contents of Item

see

Parser.readDefaultOptions

see

Parser.readOptionTypes

Parameters
- item: BaseItem
  
  target
- Optional options: BaseReadOption
Returns string | Buffer

reading result

readItems

readItems(items: BaseItem[], options?: BaseReadOption): (string | Buffer)[]

Inherited from ComicParser.readItems
- Defined in parser-core/type/Parser.d.ts:234
Reading contents of Items

async

see

Parser.readDefaultOptions

see

Parser.readOptionTypes

Parameters
- items: BaseItem[]
  
  targets
- Optional options: BaseReadOption
Returns (string | Buffer)[]

reading results

unzip

unzip(unzipPath: string, overwrite?: boolean): Promise<boolean>

Inherited from ComicParser.unzip
- Defined in parser-core/type/Parser.d.ts:271
Unzip

async

throws

{Errors.EINVAL} invalid options or value type

throws

{Errors.ENOENT} no such file or directory

throws

{Errors.ENOFILE} no such file

Parameters
- unzipPath: string
- Optional overwrite: boolean
Returns Promise<boolean>

success

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

input: string

Optional cryptoProvider: CryptoProvider

Optional logLevel: string

Returns EpubParser

Accessors

cryptoProvider

Returns CryptoProvider

input

Returns string

logger

Returns Logger

onProgress

Returns (step: number, totalStep: number, action: string) => void

Parameters

step: number

totalStep: number

action: string

Returns void

Parameters

arg: (step: number, totalStep: number, action: string) => void

Parameters

step: number

totalStep: number

action: string

Returns void

Returns any

Static parseDefaultOptions

Returns { additionalInlineStyle: any; allowNcxFileMissing: boolean; overwrite: boolean; parseStyle: boolean; styleNamespacePrefix: string; unzipPath: string; validatePackage: boolean }

additionalInlineStyle: any

allowNcxFileMissing: boolean

overwrite: boolean

parseStyle: boolean

styleNamespacePrefix: string

unzipPath: string

validatePackage: boolean

Static parseOptionTypes

Returns { additionalInlineStyle: string; allowNcxFileMissing: string; overwrite: string; parseStyle: string; styleNamespacePrefix: string; unzipPath: string; validatePackage: string }

additionalInlineStyle: string

allowNcxFileMissing: string

overwrite: string

parseStyle: string

styleNamespacePrefix: string

unzipPath: string

validatePackage: string

Static readDefaultOptions

Returns { force: boolean } & { basePath: string; extractBody: boolean; ignoreScript: boolean; removeAtrules: string[]; removeClassSelector: string[]; removeIdSelector: string[]; removeTagSelector: string[]; serializedAnchor: boolean }

Static readOptionTypes

Returns { force: string } & { basePath: string; extractBody: string; ignoreScript: string; removeAtrules: string; removeClassSelector: string; removeIdSelector: string; removeTagSelector: string; serializedAnchor: string }

Methods

_checkResult

Parameters

book: EpubBook

Returns EpubBook

Protected _createBook

Parameters

context: BaseParseContext

Returns Promise<BaseBook>

Protected _getBookClass

Returns {}

Protected _getParseContextClass

Returns {}

Protected _getReadContextClass

Returns {}

Protected _getReadItemClass

Returns {}

Protected _parseAfterTasks

Returns Task[]

Protected _parseBeforeTasks

Returns Task[]

_parseGuide

Parameters

guide: object