Class UserService

Methods related to the logged in user.

Index

Constructors

Accessors

Methods

getMyFictions getMyFollows getMyReadLater getNotifications login

Constructors

constructor

new UserService(req): UserService
Parameters
- req: Requester
Returns UserService
- Defined in services/user.ts:51

Accessors

isLoggedIn

get isLoggedIn(): boolean
Returns boolean
- Defined in services/user.ts:55

Methods

getMyFictions

getMyFictions(): Promise<RoyalResponse<MyFiction[]>>
Gets fictions owned and published by the currently logged in user.

Returns Promise<RoyalResponse<MyFiction[]>>
- Defined in services/user.ts:85

getMyFollows

getMyFollows(page?): Promise<RoyalResponse<Bookmark[]>>
Get the logged in users bookmarks.
Parameters
- page: number = 1
Returns Promise<RoyalResponse<Bookmark[]>>
- Defined in services/user.ts:101

getMyReadLater

getMyReadLater(page?): Promise<RoyalResponse<ReadLater[]>>
Parameters
- page: number = 1
Returns Promise<RoyalResponse<ReadLater[]>>
- Defined in services/user.ts:132

getNotifications

getNotifications(): Promise<RoyalResponse<Notification[]>>
Get a list of notifications.

Returns Promise<RoyalResponse<Notification[]>>
- Defined in services/user.ts:121

login

login(email, password): Promise<RoyalResponse<string>>
Log on to royalroad, saving the cookies for use in subsequent requests. Ignores existing login status.
Parameters
- email: string
- password: string
Returns Promise<RoyalResponse<string>>
- Defined in services/user.ts:66