tallgrass/item/category

Types

pub type ItemCategory {
  ItemCategory(
    id: Int,
    name: String,
    items: List(Resource),
    names: List(Name),
    pocket: Resource,
  )
}

Constructors

  • ItemCategory(
      id: Int,
      name: String,
      items: List(Resource),
      names: List(Name),
      pocket: Resource,
    )

Functions

pub fn fetch(client: Client) -> Result(PaginatedResource, Error)

Fetches a paginated list of item category resources.

Example

let result = category.new() |> category.fetch()
pub fn fetch_by_id(
  client: Client,
  id: Int,
) -> Result(ItemCategory, Error)

Fetches an item category given the item category ID.

Example

let result = category.new() |> category.fetch_by_id(1)
pub fn fetch_by_name(
  client: Client,
  name: String,
) -> Result(ItemCategory, Error)

Fetches an item category given the item category name.

Example

let result = category.new() |> category.fetch_by_name("stat-boosts")
pub fn fetch_resource(
  client: Client,
  resource: Resource,
) -> Result(ItemCategory, Error)

Fetches an item category given an item category resource.

Example

let client = category.new()
use res <- result.try(client |> category.fetch())
let assert Ok(first) = res.results |> list.first
client |> category.fetch_resource(first)
pub fn new() -> Client

Creates a new Client. This is a re-export of client.new, for the sake of convenience.

Search Document