Class Spigot

A client wrapper for the Spigot XenforoResourceManagerAPI.

Hierarchy

Spigot

Index

Constructors

Properties

Methods

findAuthor getAuthor getResource getResourceCategories getResourceUpdate getResourceUpdates getResources getResourcesByAuthor

Constructors

constructor

new Spigot(baseUrl?): Spigot
Constructor for the Spigot client.
Parameters
- baseUrl: string = "https://api.spigotmc.org/simple/0.2/index.php"
  
  The base URL of the Spigot API.
Returns Spigot
- Defined in Spigot.ts:22

Properties

`Private` `Readonly` _axios

_axios: AxiosInstance

The axios instance used to make requests.

Methods

findAuthor

findAuthor(name): Promise<undefined | Author>
Find a specific author by name.
Parameters
- name: string
  
  The name of the author.
Returns Promise<undefined | Author>
A promise resolving the author. Resolves to undefined if the author does not exist.
- Defined in Spigot.ts:193

getAuthor

getAuthor(authorId): Promise<undefined | Author>
Get a specific author.
Parameters
- authorId: number
  
  The id of the author.
Returns Promise<undefined | Author>
A promise resolving the author. Resolves to undefined if the author does not exist.
- Defined in Spigot.ts:169

getResource

getResource(resourceId): Promise<undefined | Resource>
Get a specific resource by its ID.
Parameters
- resourceId: number
  
  The id of the resource.
Returns Promise<undefined | Resource>
A promise resolving the resource. Resolves to undefined if the resource does not exist.
- Defined in Spigot.ts:36

getResourceCategories

getResourceCategories(): Promise<ResourceCategory[]>
Get a list of all categories.

Returns Promise<ResourceCategory[]>
A promise resolving to a list of categories.
- Defined in Spigot.ts:103

getResourceUpdate

getResourceUpdate(updateId): Promise<undefined | ResourceUpdate>
Get a specific resource update by its ID.
Parameters
- updateId: number
  
  The id of the update.
Returns Promise<undefined | ResourceUpdate>
A promise resolving the update. Resolves to undefined if the update does not exist.
- Defined in Spigot.ts:122

getResourceUpdates

getResourceUpdates(resourceId, page?): Promise<ResourceUpdate[]>
Get a list of updates for a specific resource.
Parameters
- resourceId: number
  
  The id of the resource.
- Optional page: number
  
  The page.
Returns Promise<ResourceUpdate[]>
A promise resolving to a list of updates.
- Defined in Spigot.ts:148

getResources

getResources(categoryId?, page?): Promise<Resource[]>
Get a list of resources. The results are paginated.
Parameters
- Optional categoryId: number
  
  The id of the category to get the resources from.
- Optional page: number
  
  The page.
Returns Promise<Resource[]>
A promise resolving the resources.
- Defined in Spigot.ts:61

getResourcesByAuthor

getResourcesByAuthor(authorId, page?): Promise<Resource[]>
Get the resources of the given author. The results are paginated.
Parameters
- authorId: number
  
  The id of the author.
- Optional page: number
  
  The page.
Returns Promise<Resource[]>
Resolves to a list of resources.
- Defined in Spigot.ts:83

Generated using TypeDoc