Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AdminFavoritesService

Admin favorites services.

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly dbm

dbm: default

Methods

favorite

  • favorite(postID: string): Promise<string>

  • Favorite a post.

    Parameters

    • postID: string

      A post's ID.

    Returns Promise<string>

    The new favorite's ID.

getFavorite

  • Get an admin favorite record.

    Parameters

    • favoriteID: string

      A favorite's ID.

    Returns Promise<AdminFavorites>

    The admin favorite record.

getFavoriteByPostID

  • Get an admin favorite record by post ID.

    Parameters

    • postID: string

      A post's ID.

    Returns Promise<AdminFavorites>

    The admin favorite record.

getFavoritePosts

  • getFavoritePosts(): Promise<Post[]>

  • Get all admin favorite posts.

    Returns Promise<Post[]>

    All admin favorited posts.

getFavorites

  • Get all admin favorites.

    Returns Promise<AdminFavorites[]>

    All admin favorited items.

getRecentFavorites

  • getRecentFavorites(num: number): Promise<Post[]>

  • Get the n most recent favorited posts.

    Parameters

    • num: number

      The number of favorited posts to return.

    Returns Promise<Post[]>

    Recently made favorited posts.

isFavorite

  • isFavorite(postID: string): Promise<boolean>

  • Check if a post is an admin favorite.

    Parameters

    • postID: string

      A post's ID.

    Returns Promise<boolean>

    Whether or not the post is an admin favorite.

unfavorite

  • unfavorite(postID: string): Promise<void>

  • Unfavorite a post.

    Parameters

    • postID: string

      A post's ID.

    Returns Promise<void>

Generated using TypeDoc