Class FictionService

Fiction and chapter related methods.

Index

Constructors

Methods

getFiction getRandom getReviews

Constructors

constructor

new FictionService(req): FictionService
Parameters
- req: Requester
Returns FictionService
- Defined in services/fiction.ts:80

Methods

getFiction

getFiction(id): Promise<RoyalResponse<Fiction>>
Returns a Fiction object scraped from the specified fictions page, throws an error if it wasn't found.
Parameters
- id: number
  ID of the fiction to get. (royalroadl.com/fiction/)
Returns Promise<RoyalResponse<Fiction>>
- Fiction object.
- Defined in services/fiction.ts:91

getRandom

getRandom(): Promise<RoyalResponse<Fiction>>
Equivalent to royalroadl.com/fictions/random AKA 'Surprise me!', returns a random fiction.

Returns Promise<RoyalResponse<Fiction>>
- Fiction object.
- Defined in services/fiction.ts:105

getReviews

getReviews(id, page?): Promise<RoyalResponse<Review[]>>
Returns reviews of a given fiction.
Parameters
- id: number
  ID of the fiction to get reviews for.
- page: number | "last" = 1
  Page number or 'last'.
Returns Promise<RoyalResponse<Review[]>>
- Defined in services/fiction.ts:119