Class Novel

Hierarchy

Historian
- Novel

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Novel(id: string, location?: undefined | string): Novel

Overrides Historian.constructor
- Defined in src/models/novel/Novel.ts:179
Parameters
- id: string
- Optional location: undefined | string
Returns Novel

Properties

Private _chapters

_chapters: SortedArrayMap<NovelChapter>

Private _downloadAt

_downloadAt: Moment

Private _id

_id: string

Private Optional _location

_location: undefined | string

Private Optional _name

_name: undefined | string

Private Optional _updateAt

_updateAt: Moment

Accessors

chapterSize

get chapterSize(): object

- Defined in src/models/novel/Novel.ts:95
Returns object
- end: number
- list: (string | number)[]
- size: number
- start: number

closedChapter

get closedChapter(): NovelChapter[]

- Defined in src/models/novel/Novel.ts:83
Returns NovelChapter[]

completedChapter

get completedChapter(): NovelChapter[]

- Defined in src/models/novel/Novel.ts:79
Returns NovelChapter[]

description

get description(): string

- Defined in src/models/novel/Novel.ts:46
Returns string

id

get id(): string

- Defined in src/models/novel/Novel.ts:38
Returns string

lastUpdate

set lastUpdate($: CheerioStatic): void

- Defined in src/models/novel/Novel.ts:70
Parameters
- $: CheerioStatic
Returns void

lastUpdateAt

get lastUpdateAt(): Moment

- Defined in src/models/novel/Novel.ts:50
Returns Moment

location

get location(): string
set location(v: string): void

- Defined in src/models/novel/Novel.ts:34
Returns string
- Defined in src/models/novel/Novel.ts:65
Parameters
- v: string
Returns void

name

get name(): string
set name(n: string): void

- Defined in src/models/novel/Novel.ts:42
Returns string
- Defined in src/models/novel/Novel.ts:58
Parameters
- n: string
Returns void

soldChapter

get soldChapter(): NovelChapter[]

- Defined in src/models/novel/Novel.ts:87
Returns NovelChapter[]

startDownloadAt

get startDownloadAt(): Moment

- Defined in src/models/novel/Novel.ts:54
Returns Moment

unknownChapter

get unknownChapter(): NovelChapter[]

- Defined in src/models/novel/Novel.ts:91
Returns NovelChapter[]

Methods

addChapter

addChapter(chapter: NovelChapter): void

- Defined in src/models/novel/Novel.ts:202
Parameters
- chapter: NovelChapter
Returns void

chapter

chapter(__namedParameters: object): NovelChapter[]

- Defined in src/models/novel/Novel.ts:280
Parameters
- __namedParameters: object
  - copy: boolean
Returns NovelChapter[]

eachChapter

eachChapter(fn: function): void

- Defined in src/models/novel/Novel.ts:296
Parameters
- fn: function
  - - (n: NovelChapter, index?: undefined | number): void
    - Parameters
      - n: NovelChapter
      - Optional index: undefined | number
      Returns void
Returns void

filterChapter

filterChapter(fn: function): NovelChapter[]

- Defined in src/models/novel/Novel.ts:292
Parameters
- fn: function
  - - (n: NovelChapter, index?: undefined | number): boolean
    - Parameters
      - n: NovelChapter
      - Optional index: undefined | number
      Returns boolean
Returns NovelChapter[]

getChapter

getChapter(key: number | NovelChapter): undefined | NovelChapter

- Defined in src/models/novel/Novel.ts:195
Parameters
- key: number | NovelChapter
Returns undefined | NovelChapter

history

history(): History

Inherited from Historian.history
- Defined in src/models/history/Historian.ts:31
Returns History

Protected initial

initial(): void

Inherited from Historian.initial
- Defined in src/models/history/Historian.ts:12
Returns void

linkTo

linkTo(historian: Historian): void

Inherited from Historian.linkTo
- Defined in src/models/history/Historian.ts:39
Parameters
- historian: Historian
Returns void

load

load($: CheerioStatic): Bluebird<Novel>

- Defined in src/models/novel/Novel.ts:306
Parameters
- $: CheerioStatic
Returns Bluebird<Novel>

Protected loadObserver

loadObserver(observer: Observer<HistoryNode>): void

Inherited from Observable.loadObserver
- Defined in src/models/Observable.ts:14
Parameters
- observer: Observer<HistoryNode>
Returns void

mapChapter

mapChapter(fn: function): any[]

- Defined in src/models/novel/Novel.ts:288
Parameters
- fn: function
  - - (n: NovelChapter, index?: undefined | number): any
    - Parameters
      - n: NovelChapter
      - Optional index: undefined | number
      Returns any
Returns any[]

notify

notify(result: HistoryNode | undefined): void

Inherited from Observable.notify
- Defined in src/models/Observable.ts:18
Parameters
- result: HistoryNode | undefined
Returns void

observe

observe(): undefined | Observer<T>

Inherited from Observable.observe
- Defined in src/models/Observable.ts:22
Returns undefined | Observer<T>

pauseObserve

pauseObserve(): void

Inherited from Observable.pauseObserve
- Defined in src/models/Observable.ts:26
Returns void

replaceChapter

replaceChapter(chap: NovelChapter): boolean

- Defined in src/models/novel/Novel.ts:218
Parameters
- chap: NovelChapter
Returns boolean

resetChapter

resetChapter(): void

- Defined in src/models/novel/Novel.ts:237
Returns void

resetHistory

resetHistory(): void

Inherited from Historian.resetHistory
- Defined in src/models/history/Historian.ts:35
Returns void

saveAll

saveAll(__namedParameters: object): Promise<this>

- Defined in src/models/novel/Novel.ts:343
Parameters
- __namedParameters: object
  - force: boolean
  - completeFn: function
    - completeFn(_: NovelChapter): void
    - Defined in src/models/novel/Novel.ts:343
      Parameters
      - _: NovelChapter
      Returns void
Returns Promise<this>

Private saveChapters

saveChapters(__namedParameters: object): Bluebird<NovelChapter[]>

- Defined in src/models/novel/Novel.ts:139
Parameters
- __namedParameters: object
  - force: boolean
  - validate: boolean
  - completeFn: function
    - completeFn(_: NovelChapter): void
    - Defined in src/models/novel/Novel.ts:142
      Parameters
      - _: NovelChapter
      Returns void
  - completedFn: function
    - completedFn(_: NovelChapter): void
    - Defined in src/models/novel/Novel.ts:143
      Parameters
      - _: NovelChapter
      Returns void
  - failFn: function
    - failFn(_: NovelChapter): void
    - Defined in src/models/novel/Novel.ts:144
      Parameters
      - _: NovelChapter
      Returns void
Returns Bluebird<NovelChapter[]>

saveNovel

saveNovel(__namedParameters: object): Promise<this>

- Defined in src/models/novel/Novel.ts:327
Parameters
- __namedParameters: object
  - force: boolean
  - completeFn: function
    - completeFn(_: NovelChapter): void
    - Defined in src/models/novel/Novel.ts:329
      Parameters
      - _: NovelChapter
      Returns void
  - completedFn: function
    - completedFn(_: NovelChapter): void
    - Defined in src/models/novel/Novel.ts:330
      Parameters
      - _: NovelChapter
      Returns void
  - failFn: function
    - failFn(_: NovelChapter): void
    - Defined in src/models/novel/Novel.ts:331
      Parameters
      - _: NovelChapter
      Returns void
Returns Promise<this>

saveResource

saveResource(__namedParameters: object): Bluebird<this>

- Defined in src/models/novel/Novel.ts:321
Parameters
- __namedParameters: object
  - force: boolean
Returns Bluebird<this>

Private saveZero

saveZero(__namedParameters: object): Promise<void>

- Defined in src/models/novel/Novel.ts:130
Parameters
- __namedParameters: object
  - force: boolean
  - validate: boolean
Returns Promise<void>

setAll

setAll(setting: object): void

- Defined in src/models/novel/Novel.ts:241
Parameters
- setting: object
  - Optional chapters?: NovelChapterResourceType[]
  - Optional downloadAt?: undefined | string
  - Optional id?: undefined | string
  - Optional lastUpdate?: undefined | string
  - Optional name?: undefined | string
Returns void

setHistory

setHistory(nodes: HistoryNodeType[]): void

- Defined in src/models/novel/Novel.ts:263
Parameters
- nodes: HistoryNodeType[]
Returns void

startObserve

startObserve(): void

Inherited from Observable.startObserve
- Defined in src/models/Observable.ts:30
Returns void

toJSON

toJSON(): object

- Defined in src/models/novel/Novel.ts:354
Returns object
- chapters: any[]
- id: string
- lastUpdate: undefined | string
- name: string

update

update(): Bluebird<Novel>

- Defined in src/models/novel/Novel.ts:300
Returns Bluebird<Novel>

Protected updateHistory

updateHistory(history: History): void

Inherited from Historian.updateHistory
- Defined in src/models/history/Historian.ts:16
Parameters
- history: History
Returns void

Private validateBeforeSave

validateBeforeSave(__namedParameters: object): Promise<void>

- Defined in src/models/novel/Novel.ts:123
Parameters
- __namedParameters: object
  - force: boolean
Returns Promise<void>

Generated using TypeDoc