Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace tags

Collection of Tag related API functions

Index

Functions

Functions

createTag

  • createTag(name: string, categoryName?: undefined | string, aliases?: string[]): Promise<Tag | undefined>

  • Creates a new Tag

    Parameters

    • name: string

      Name of the primary alias

    • Optional categoryName: undefined | string

      Name of the category to use, Default if none given

    • Optional aliases: string[]

      List of extra aliases to register

    Returns Promise<Tag | undefined>

createTagCategory

  • createTagCategory(name: string, color: string): Promise<TagCategory | undefined>

deleteTag

  • deleteTag(tagId: number, skipWarn?: undefined | false | true): Promise<boolean>

  • Removes a Tag (from all Games)

    Parameters

    • tagId: number

      ID of Tag to remove

    • Optional skipWarn: undefined | false | true

      If true, warn user before deleting tag from games.

    Returns Promise<boolean>

deleteTagCategory

  • deleteTagCategory(tagCategoryId: number): Promise<boolean>

  • Removes a Tag Category. All owned Tags are moved to the first available Tag Category.

    Parameters

    • tagCategoryId: number

      ID of the Tag Category to remove

    Returns Promise<boolean>

findGameTags

  • findGameTags(gameId: string): Promise<Tag[] | undefined>

findTag

  • findTag(name: string): Promise<Tag | undefined>

findTagCategories

findTagSuggestions

findTags

  • findTags(name?: undefined | string): Promise<Tag[]>

  • Finds a list of tags that begins with a name (if given)

    Parameters

    • Optional name: undefined | string

      Partial name that a tag starts with

    Returns Promise<Tag[]>

getTagById

  • getTagById(tagId: number): Promise<Tag | undefined>

getTagCategoryById

  • getTagCategoryById(categoryId: number): Promise<TagCategory | undefined>

mergeTags

saveTag

  • saveTag(tag: Tag): Promise<Tag>

saveTagCategory

Generated using TypeDoc