TorrentSearch | torrent-api-ts

Hierarchy

TorrentSearch

Index

Constructors

constructor

Properties

Accessors

delayBetweenRequests

Methods

Constructors

constructor

new TorrentSearch(appName: string, userAgent?: undefined | string, endpoint?: undefined | string): TorrentSearch

- Defined in torrent-api-ts.ts:15
The search object

Parameters
- appName: string
  
  needed TorrentApi to identify the client
- Optional userAgent: undefined | string
  
  in case the one we set stop workin (chrome vers. 60)
- Optional endpoint: undefined | string
  
  if the end point change and we didn't update fast enough, you can change it here
Returns TorrentSearch

Properties

Private _appName

_appName: string

Private _endpoint

_endpoint: string = "https://torrentapi.org/pubapi_v2.php"

Private _queue

_queue: PromiseThrottler = new PromiseThrottler(2000)

Private _token

_token: Token = Token.expired()

Private _userAgent

_userAgent: string = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.113 Safari/537.36"

Accessors

delayBetweenRequests

delayBetweenRequests:

Change delay between each request

Only change this if you know what you're doing

Methods

Private _delayedRequest

_delayedRequest<T>(params: RequestParams): Promise<T>

- Defined in torrent-api-ts.ts:110
The API is rate limited, be sure to only do the request in the right time to avoid hitting the rate limiting

Type parameters
- T
Parameters
- params: RequestParams
Returns Promise<T>

Private _processRequest

_processRequest<T>(params: RequestParams): Promise<T>

- Defined in torrent-api-ts.ts:122
Set all the query parameters for the request

Check also for token expired

Type parameters
- T
Parameters
- params: RequestParams
Returns Promise<T>

Private _request

_request<T>(params: RequestParams): Promise<T>

- Defined in torrent-api-ts.ts:90
Do request on the api

Type parameters
- T
Parameters
- params: RequestParams
Returns Promise<T>

Private ensureToken

ensureToken(): Promise<Token>

- Defined in torrent-api-ts.ts:66
Ensure we have a valid token to do requests on their API

Returns Promise<Token>

search

search(search: string, category: SearchCategory): Promise<TorrentCollection>

- Defined in torrent-api-ts.ts:58
Search and in which category

Parameters
- search: string
- category: SearchCategory
Returns Promise<TorrentCollection>

searchAdvanced

searchAdvanced(search: SearchParams): Promise<TorrentCollection>

- Defined in torrent-api-ts.ts:48
Advanced search with possibility to set all the different parameters

Parameters
- search: SearchParams
Returns Promise<TorrentCollection>

Generated using TypeDoc