Skip to content

(character): Add support for fetching mounts #22

@ReidWeb

Description

@ReidWeb

The ability to fetch the set of mounts a character has is required.

These mounts are presently contained on a sub-page on the lodestone so require a second GET, to fetch.

Use Case

  1. As a consumer of the lodestone module I should be able to ask it to fetch a character, and return the ids of all the mounts they have. (Default)
  2. As a consumer of the lodestone module I should be able to ask it to fetch a character, and return the names of all the mounts they have. (Expand)
  3. As a consumer of the lodestone module I should be able to ask it to fetch a character but specify not to fetch mounts. (Disabled)
  4. As a consumer of the lodestone module I should be able to ask it to fetch a character's mounts (either as IDs or expanded names) without fetching the whole character.

Proposed Solution

  • Implement Item lookup function MVP (just name)
  • Implement function to lookup a series of provided IDs
  • Implement function for retrieval of ids of mounts
  • Implement function that calls mount id retrieval function than passes values to item lookup
  • In lodestoneClient.getCharacter(..) add an options object, with parameter fetchMountNames of type boolean
  • If fetchMountNames is true in options call invoke the function that fetches and looks up names
  • In lodestoneClient.getCharacter(..) add an options object, with parameter fetchMoundIds of type boolean
  • If fetchMountIds is true in options call invoke the function that fetches just ids

Other

No modifications to Character.fromPage are required.

  • 👋 I may be able to implement this feature request
  • ⚠️ This feature might incur a breaking change

This is a 🚀 Feature Request

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions