Class NovelSite

Hierarchy

NovelSite
- NovelSiteDemo
- NovelSiteDmzj

Implements

INovelSite

Index

Interfaces

Type aliases

Constructors

constructor

Properties

Accessors

IDKEY

Type aliases

Static IDownloadOptions

IDownloadOptions: object & IOptionsPlus

Static IOptions

IOptions: object & IOptionsPlus

Static IOptionsPlus

IOptionsPlus: object

Type declaration

Optional allowEmptyVolumeTitle?: boolean
Optional disableOutputDirPrefix?: boolean
Optional event?: EventEmitter
Optional fetchMetaDataOnly?: boolean

只抓取小說的 META 資料
Optional filePrefixMode?: number
Optional noDirPadend?: boolean
Optional noDirPrefix?: boolean
Optional noFilePadend?: boolean
Optional noFirePrefix?: boolean
Optional retryDelay?: number
Optional sessionData?: object

用來登入站點的 cookies session
- [key: string]: any
Optional startIndex?: number

Static IOptionsRuntime

IOptionsRuntime: IOptions & IDownloadOptions & IOptionsPlus

Constructors

constructor

new NovelSite(options: IOptions, ...argv: any[]): NovelSite

- Defined in src/site/index.ts:42
Parameters
- options: IOptions
- Rest ...argv: any[]
Returns NovelSite

Properties

PATH_NOVEL_MAIN

PATH_NOVEL_MAIN: string

Optional optionsInit

optionsInit: IOptions

Static IDKEY

IDKEY: string = null

Accessors

IDKEY

get IDKEY(): string

- Defined in src/site/index.ts:107
Returns string

Methods

Protected _checkExists

_checkExists(optionsRuntime: IOptionsRuntime, file: string): boolean

- Defined in src/site/index.ts:282
Parameters
- optionsRuntime: IOptionsRuntime
- file: string
Returns boolean

Protected _createChapterUrl

_createChapterUrl<T>(__namedParameters: object, optionsRuntime?: T & IOptionsRuntime): URL

- Defined in src/site/index.ts:253
Type parameters
- T
Parameters
- __namedParameters: object
  - chapter: IChapter
  - novel: INovel
  - volume: IVolume
- Optional optionsRuntime: T & IOptionsRuntime
Returns URL

Protected _fetchChapter

_fetchChapter<T>(url: URL, optionsRuntime: T & IOptionsRuntime): void

- Defined in src/site/index.ts:267
Type parameters
- T
Parameters
- url: URL
- optionsRuntime: T & IOptionsRuntime
Returns void

Protected _fixOptionsRuntime

_fixOptionsRuntime<T>(optionsRuntime: T & IOptionsRuntime): T & IOptionsRuntime

- Defined in src/site/index.ts:158
Type parameters
- T
Parameters
- optionsRuntime: T & IOptionsRuntime
Returns T & IOptionsRuntime

Protected _parseChapter

_parseChapter<T>(dom: any, optionsRuntime: T & IOptionsRuntime, cache: object): void

- Defined in src/site/index.ts:272
Type parameters
- T
Parameters
- dom: any
- optionsRuntime: T & IOptionsRuntime
- cache: object
  - chapter: IChapter
  - file: string
  - novel: INovel
  - volume: IVolume
Returns void

Protected _saveReadme

_saveReadme(optionsRuntime?: IOptionsRuntime, options?: object, ...opts: any[]): Promise<object>

- Defined in src/site/index.ts:194
Parameters
- Optional optionsRuntime: IOptionsRuntime
- Default value options: object = {}
- Rest ...opts: any[]
Returns Promise<object>

createMainUrl

createMainUrl(url: string): URL
createMainUrl(url: URL): URL

- Defined in src/site/index.ts:237
Parameters
- url: string
Returns URL
- Defined in src/site/index.ts:238
Parameters
- url: URL
Returns URL

download

download(url: string | URL, options?: IDownloadOptions): PromiseBluebird<INovel>

Implementation of INovelSite.download
- Defined in src/site/index.ts:79
Parameters
- url: string | URL
- Optional options: IDownloadOptions
Returns PromiseBluebird<INovel>

Protected emit

emit(event: EventEmitter, eventName: string, ...argv: any[]): (true | false | internal)[]

- Defined in src/site/index.ts:297
Parameters
- event: EventEmitter
- eventName: string
- Rest ...argv: any[]
Returns (true | false | internal)[]

getOutputDir

getOutputDir<T>(options?: T & IOptions, novelName?: string): [string, T & IOptions]

- Defined in src/site/index.ts:119
Type parameters
- T
Parameters
- Optional options: T & IOptions
- Optional novelName: string
Returns [string, T & IOptions]

getStatic

getStatic<T>(): T

- Defined in src/site/index.ts:101
Type parameters
- T
Returns T

get_volume_list

get_volume_list<T>(url: string | URL, optionsRuntime?: Partial<T & IDownloadOptions>): Promise<INovel>

- Defined in src/site/index.ts:84
Type parameters
- T
Parameters
- url: string | URL
- Default value optionsRuntime: Partial<T & IDownloadOptions> = {}
Returns Promise<INovel>

makeUrl

makeUrl(urlobj: IParseUrl, options?: any): URL

Implementation of INovelSite.makeUrl
- Defined in src/site/index.ts:91
Parameters
- urlobj: IParseUrl
- Optional options: any
Returns URL

parseUrl

parseUrl(url: URL | string, options?: any): IParseUrl

- Defined in src/site/index.ts:96
Parameters
- url: URL | string
- Optional options: any
Returns IParseUrl

session

session<T>(optionsRuntime: T & IOptionsRuntime, url?: URL): this

- Defined in src/site/index.ts:67
Type parameters
- T
Parameters
- optionsRuntime: T & IOptionsRuntime
- Optional url: URL
Returns this

trimFilename

trimFilename(name: any): string

- Defined in src/site/index.ts:189
Parameters
- name: any
Returns string

trimFilenameChapter

trimFilenameChapter(name: any): string

- Defined in src/site/index.ts:174
Parameters
- name: any
Returns string

trimFilenameNovel

trimFilenameNovel(name: any): string

- Defined in src/site/index.ts:184
Parameters
- name: any
Returns string

trimFilenameVolume

trimFilenameVolume(name: any): string

- Defined in src/site/index.ts:179
Parameters
- name: any
Returns string

Static check

check(url: string | URL | IParseUrl, options?: any): boolean

- Defined in src/site/index.ts:62
Parameters
- url: string | URL | IParseUrl
- Optional options: any
Returns boolean

Static create

create(options: IOptions, ...argv: any[]): NovelSite

- Defined in src/site/index.ts:57
Parameters
- options: IOptions
- Rest ...argv: any[]
Returns NovelSite

Generated using TypeDoc