Class SeederApi

Hierarchy

SeederApi

Index

Constructors

constructor

Properties

api

Methods

Constructors

constructor

new SeederApi(api: DCoreApi): SeederApi

- Defined in api/promise/SeederApi.ts:6
Parameters
- api: DCoreApi
Returns SeederApi

Properties

Private api

Methods

get

get(accountId: ChainObject): Promise<Seeder>

- Defined in api/promise/SeederApi.ts:16
Get a seeder by ID.

Parameters
- accountId: ChainObject
  
  seeder account object id
Returns Promise<Seeder>

a seeder object or ObjectNotFoundError if not found

listByPrice

listByPrice(count?: number): Promise<Seeder[]>

- Defined in api/promise/SeederApi.ts:27
Get a list of seeders by price, in increasing order.

Parameters
- Default value count: number = 100
  
  number of items to retrieve, max 100
Returns Promise<Seeder[]>

a list of seeders

listByRating

listByRating(count?: number): Promise<Seeder[]>

- Defined in api/promise/SeederApi.ts:60
Get a list of seeders by price, in decreasing order.

Parameters
- Default value count: number = 100
  
  number of items to retrieve, max 100
Returns Promise<Seeder[]>

a list of seeders

listByRegion

listByRegion(region?: Regions): Promise<Seeder[]>

- Defined in api/promise/SeederApi.ts:49
Get a list of seeders ordered by price.

Parameters
- Default value region: Regions = Regions.All
  
  defined in Regions
Returns Promise<Seeder[]>

a list of seeders

listByUpload

listByUpload(count?: number): Promise<Seeder[]>

- Defined in api/promise/SeederApi.ts:38
Get a list of seeders ordered by total upload, in decreasing order.

Parameters
- Default value count: number = 100
  
  number of items to retrieve, max 100
Returns Promise<Seeder[]>

a list of seeders

Generated using TypeDoc