Class NarouNovel`Abstract` `Private`

なろう小説APIへのリクエストを実行する NarouNovel

Hierarchy (view full)

NarouNovel
- NarouNovelFetch
- NarouNovelJsonp

Index

Constructors

Methods

execute executeNovel executeNovel18 executeRanking executeRankingHistory executeSearch executeUserSearch

Constructors

constructor

new NarouNovel(): NarouNovel
Returns NarouNovel

Methods

`Protected` `Abstract` execute

execute<T>(params, endpoint): Promise<T>
なろうAPIへのAPIリクエストを実行する
Type Parameters
- T
Parameters
- params: NarouParams
  クエリパラメータ
- endpoint: string
  APIエンドポイント
Returns Promise<T>
実行結果
- Defined in work/node-narou/node-narou/src/narou.ts:36

executeNovel

executeNovel<T>(params): Promise<NarouSearchResults<NarouSearchResult, T>>
小説APIへの検索リクエストを実行する
Type Parameters
- T extends keyof NarouSearchResult
Parameters
- params: SearchParams
  クエリパラメータ
Returns Promise<NarouSearchResults<NarouSearchResult, T>>
検索結果

See
https://dev.syosetu.com/man/api/
- Defined in work/node-narou/node-narou/src/narou.ts:60

executeNovel18

executeNovel18<T>(params): Promise<NarouSearchResults<NarouSearchResult, T>>
R18小説APIへの検索リクエストを実行する
Type Parameters
- T extends keyof NarouSearchResult
Parameters
- params: SearchParams
  クエリパラメータ
Returns Promise<NarouSearchResults<NarouSearchResult, T>>
検索結果

See
https://dev.syosetu.com/xman/api/
- Defined in work/node-narou/node-narou/src/narou.ts:75

executeRanking

executeRanking(params): Promise<NarouRankingResult[]>
ランキングAPIへのリクエストを実行する
Parameters
- params: RankingParams
  クエリパラメータ
Returns Promise<NarouRankingResult[]>
ランキング結果

See
https://dev.syosetu.com/man/rankapi/
- Defined in work/node-narou/node-narou/src/narou.ts:90

executeRankingHistory

executeRankingHistory(params): Promise<RankingHistoryRawResult[]>
殿堂入りAPiへのリクエストを実行する
Parameters
- params: RankingHistoryParams
  クエリパラメータ
Returns Promise<RankingHistoryRawResult[]>
ランキング履歴結果

See
https://dev.syosetu.com/man/rankinapi/
- Defined in work/node-narou/node-narou/src/narou.ts:100

`Protected` executeSearch

executeSearch<T>(params, endpoint?): Promise<NarouSearchResults<NarouSearchResult, T>>
APIへの検索リクエストを実行する
Type Parameters
- T extends keyof NarouSearchResult
Parameters
- params: SearchParams
  クエリパラメータ
- endpoint: string = "https://api.syosetu.com/novelapi/api/"
  APIエンドポイント
Returns Promise<NarouSearchResults<NarouSearchResult, T>>
検索結果
- Defined in work/node-narou/node-narou/src/narou.ts:47

executeUserSearch

executeUserSearch<T>(params): Promise<NarouSearchResults<UserSearchResult, T>>
ユーザー検索APIへのリクエストを実行する
Type Parameters
- T extends keyof UserSearchResult
Parameters
- params: UserSearchParams
  クエリパラメータ
Returns Promise<NarouSearchResults<UserSearchResult, T>>
検索結果

See
https://dev.syosetu.com/man/userapi/
- Defined in work/node-narou/node-narou/src/narou.ts:112

Generated using TypeDoc