Parser | @ridi/content-parser

Hierarchy

Parser

Index

Accessors

Methods

References

Action

Re-exports Action

Constructors

constructor

new Parser(input: string, cryptoProvider?: CryptoProvider, loggerOptions?: { logLevel: LogLevel; namespace: string }): Parser

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:81
Create new Parser

throws

{Errors.ENOENT} no such file or directory

throws

{Errors.EINVAL} invalid input

example

class FooParser extends Parser { ... } new FooParser('./foo/bar.zip' or './foo/bar');

Parameters
- input: string
  
  file or directory
- Optional cryptoProvider: CryptoProvider
- Optional loggerOptions: { logLevel: LogLevel; namespace: string }
  - logLevel: LogLevel
  - namespace: string
Returns Parser

Properties

Private _unzipTasks

_unzipTasks: any

returns: return tasks

Accessors

cryptoProvider

get cryptoProvider(): CryptoProvider

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:106
Get en/decrypto provider

Returns CryptoProvider

input

get input(): string

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:101
Get file or directory

Returns string

logger

get logger(): Logger

- Defined in content-parser/node_modules/@ridi/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

- Defined in content-parser/node_modules/@ridi/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
- Defined in content-parser/node_modules/@ridi/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(): { overwrite: boolean; unzipPath: string }

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:63
Get default values of parse options

static

Returns { overwrite: boolean; unzipPath: string }
- overwrite: boolean
  
  If true, overwrite to unzipPath when unzip. (only using if unzipPath specified.)
- unzipPath: string
  
  If specified, unzip to that path.

Static parseOptionTypes

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

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:69
Get types of parse options

static

Returns { overwrite: string; unzipPath: string }
- overwrite: string
  
  /
  
  /**
- unzipPath: string

Static readDefaultOptions

get readDefaultOptions(): void | { force: boolean }

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:75
Get default values of read options

static

Returns void | { force: boolean }

Static readOptionTypes

get readOptionTypes(): void | { force: string }

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:81
Get types of read option

static

Returns void | { force: string }

Methods

Protected _createBook

_createBook(context: BaseParseContext): Promise<BaseBook>

- Defined in content-parser/node_modules/@ridi/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(): {}

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:138
virtual

Returns {}

Protected _getParseContextClass

_getParseContextClass(): {}

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:132
virtual

Returns {}

Protected _getReadContextClass

_getReadContextClass(): {}

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:144
virtual

Returns {}

Protected _getReadItemClass

_getReadItemClass(): {}

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:150
virtual

Returns {}

Protected _parseAfterTasks

_parseAfterTasks(): Task[]

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:165
Returns Task[]

return after tasks

Protected _parseBeforeTasks

_parseBeforeTasks(): Task[]

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:155
Returns Task[]

return before tasks

Protected _parseTasks

_parseTasks(): Task[]

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:160
Returns Task[]

return tasks

_prepareParse

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

- Defined in content-parser/node_modules/@ridi/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>

- Defined in content-parser/node_modules/@ridi/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>>

- Defined in content-parser/node_modules/@ridi/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[]

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:215
Returns Task[]

return after tasks

Protected _readBeforeTasks

_readBeforeTasks(): Task[]

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:205
Returns Task[]

return before tasks

Protected _readTasks

_readTasks(): Task[]

- Defined in content-parser/node_modules/@ridi/parser-core/type/Parser.d.ts:210
Returns Task[]

return tasks

_unzipIfNeeded

_unzipIfNeeded(context: BaseParseContext): Promise<BaseParseContext>

- Defined in content-parser/node_modules/@ridi/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>

- Defined in content-parser/node_modules/@ridi/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

- Defined in content-parser/node_modules/@ridi/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)[]

- Defined in content-parser/node_modules/@ridi/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>

- Defined in content-parser/node_modules/@ridi/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

References

Constructors

Properties

Accessors

Methods

References

Action

Constructors

constructor

Parameters

input: string

Optional cryptoProvider: CryptoProvider

Optional loggerOptions: { logLevel: LogLevel; namespace: string }

logLevel: LogLevel

namespace: string

Returns Parser

Properties

Private _unzipTasks

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

overwrite: boolean

unzipPath: string

Static parseOptionTypes

Returns { overwrite: string; unzipPath: string }

overwrite: string

unzipPath: string

Static readDefaultOptions

Returns void | { force: boolean }

Static readOptionTypes

Returns void | { force: string }

Methods

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[]

Protected _parseTasks

Returns Task[]

_prepareParse

Parameters

Optional options: BaseParserOption

Returns Promise<BaseParseContext>

_prepareRead

Parameters

items: any[]