ComicParser | @ridi/content-parser

Hierarchy

Parser
- ComicParser

Index

Constructors

constructor

new ComicParser(input: string, cryptoProvider: CryptoProvider, logLevel: { DEBUG: string; ERROR: string; INFO: string; SILENT: string; VERBOSE: string; WARN: string }): ComicParser

Overrides Parser.constructor
- Defined in content-parser/node_modules/@ridi/comic-parser/type/ComicParser.d.ts:47
Create new ComicParser

throws

{Errors.ENOENT} no such file or directory

throws

{Errors.EINVAL} invalid input

example

new ComicParser('./foo/bar.zip' or './foo/bar');

Parameters
- input: string
  
  file or directory
- cryptoProvider: CryptoProvider
  
  en/decrypto provider
- logLevel: { DEBUG: string; ERROR: string; INFO: string; SILENT: string; VERBOSE: string; WARN: string }
  
  logging level
  - DEBUG: string
    
    "debug"
  - ERROR: string
    
    "error"
  - INFO: string
    
    "info"
  - SILENT: string
    
    "silent"
  - VERBOSE: string
    
    "verbose"
  - WARN: string
    
    "warn"
Returns ComicParser

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(): { ext: string[]; overwrite: boolean; parseImageSize: boolean; unzipPath: string }

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

Returns { ext: string[]; overwrite: boolean; parseImageSize: boolean; unzipPath: string }
- ext: string[]
- overwrite: boolean
- parseImageSize: boolean
- unzipPath: string

Static parseOptionTypes

get parseOptionTypes(): { ext: string; overwrite: string; parseImageSize: string; unzipPath: string }

Overrides Parser.parseOptionTypes
- Defined in content-parser/node_modules/@ridi/comic-parser/type/ComicParser.d.ts:15
Get types of parse options

Returns { ext: string; overwrite: string; parseImageSize: string; unzipPath: string }
- ext: string
- overwrite: string
- parseImageSize: string
- unzipPath: string

Static readDefaultOptions

get readDefaultOptions(): { force: boolean } & { base64: boolean }

Overrides Parser.readDefaultOptions
- Defined in content-parser/node_modules/@ridi/comic-parser/type/ComicParser.d.ts:31
Get default values of read options

Returns { force: boolean } & { base64: boolean }

Static readOptionTypes

get readOptionTypes(): { force: string } & { base64: string }

Overrides Parser.readOptionTypes
- Defined in content-parser/node_modules/@ridi/comic-parser/type/ComicParser.d.ts:45
Get types of read option

Returns { force: string } & { base64: string }

Methods

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 {}

_parse

_parse(context: ComicReadContext): Promise<ComicReadContext>

- Defined in content-parser/node_modules/@ridi/comic-parser/type/ComicParser.d.ts:65
extracts only necessary metadata from entries and create item list

see

ComicParser.parseDefaultOptions.ext

see

ComicParser.parseDefaultOptions.parseImageSize

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

return Context containing item list

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

_parseImageSize

_parseImageSize(entry: { entryPath: string; getFile: (options: { end: number; endocing: string }) => Promise<Buffer> | Buffer; size: number }, options: { ext: string[]; overwrite: boolean; parseImageSize: boolean; unzipPath: string }): Promise<{ height: number; width: number }>

- Defined in content-parser/node_modules/@ridi/comic-parser/type/ComicParser.d.ts:78
parse image size from entry

Parameters
- entry: { entryPath: string; getFile: (options: { end: number; endocing: string }) => Promise<Buffer> | Buffer; size: number }
  
  image entry
  - entryPath: string
  - getFile: (options: { end: number; endocing: string }) => Promise<Buffer> | Buffer
    - - (options: { end: number; endocing: string }): Promise<Buffer> | Buffer
      - Parameters
        
        options: { end: number; endocing: string }
        
        end: number
        
        endocing: string
        
        Returns Promise<Buffer> | Buffer
  - size: number
- options: { ext: string[]; overwrite: boolean; parseImageSize: boolean; unzipPath: string }
  
  parse options
  - ext: string[]
  - overwrite: boolean
  - parseImageSize: boolean
  - unzipPath: string
Returns Promise<{ height: number; width: number }>

return image size

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)

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

cryptoProvider: CryptoProvider

logLevel: { DEBUG: string; ERROR: string; INFO: string; SILENT: string; VERBOSE: string; WARN: string }

DEBUG: string

ERROR: string

INFO: string

SILENT: string

VERBOSE: string

WARN: string

Returns ComicParser

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 { ext: string[]; overwrite: boolean; parseImageSize: boolean; unzipPath: string }

ext: string[]

overwrite: boolean

parseImageSize: boolean

unzipPath: string

Static parseOptionTypes

Returns { ext: string; overwrite: string; parseImageSize: string; unzipPath: string }

ext: string

overwrite: string

parseImageSize: string

unzipPath: string

Static readDefaultOptions

Returns { force: boolean } & { base64: boolean }

Static readOptionTypes

Returns { force: string } & { base64: string }

Methods

Protected _createBook

Parameters

context: BaseParseContext

Returns Promise<BaseBook>

Protected _getBookClass

Returns {}

Protected _getParseContextClass

Returns {}

Protected _getReadContextClass

Returns {}

Protected _getReadItemClass

Returns {}

_parse

Parameters

context: ComicReadContext

Returns Promise<ComicReadContext>

Protected _parseAfterTasks

Returns Task[]

Protected _parseBeforeTasks

Returns Task[]

_parseImageSize

Parameters

entry: { entryPath: string; getFile: (options: { end: number; endocing: string }) => Promise<Buffer> | Buffer; size: number }