Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Responses

Index

Type Aliases

Type Aliases

GenericSuccess

GenericSuccess: { success: true }

Type declaration

  • success: true

PostInPopular

PostInPopular: { _id: string; author: { _id: string; avatar: FileInformation | null; description: string; displayName: string; username: string; verified: boolean }; createdAt: number; file: { fileName: string; size: number }; slug: string; tags: string[]; title: string; views: number }

Type declaration

  • _id: string
  • author: { _id: string; avatar: FileInformation | null; description: string; displayName: string; username: string; verified: boolean }
    • _id: string
    • avatar: FileInformation | null
    • description: string
    • displayName: string
    • username: string
    • verified: boolean
  • createdAt: number
  • file: { fileName: string; size: number }
    • fileName: string
    • size: number
  • slug: string
  • tags: string[]
  • title: string
  • views: number

PostInSearch

PostInSearch: { _id: string; author: { _id: string; avatar: FileInformation | null; description: string; displayName: string; username: string; verified: boolean }; createdAt: number; file: FileInformation; slug: string; tags: string[]; title: string; views: number }

Type declaration

  • _id: string
  • author: { _id: string; avatar: FileInformation | null; description: string; displayName: string; username: string; verified: boolean }
    • _id: string
    • avatar: FileInformation | null
    • description: string
    • displayName: string
    • username: string
    • verified: boolean
  • createdAt: number
  • file: FileInformation
  • slug: string
  • tags: string[]
  • title: string
  • views: number

PostInfoResponse

PostInfoResponse: { _id: string; author: { _id: string; avatar: FileInformation | null; description: string; displayName: string; username: string; verified: boolean }; createdAt: number; file: { fileName: string; size: number }; slug: string; tags: string[]; title: string; views: number }

Type declaration

  • _id: string
  • author: { _id: string; avatar: FileInformation | null; description: string; displayName: string; username: string; verified: boolean }
    • _id: string
    • avatar: FileInformation | null
    • description: string
    • displayName: string
    • username: string
    • verified: boolean
  • createdAt: number
  • file: { fileName: string; size: number }
    • fileName: string
    • size: number
  • slug: string
  • tags: string[]
  • title: string
  • views: number

PostNewResponse

PostNewResponse: { _id: string; author: { _id: string; avatar: FileInformation | null; description: string; displayName: string; username: string; verified: boolean }; createdAt: number; file: FileInformation; private: boolean; slug: string; tags: string[]; title: string }

Type declaration

  • _id: string
  • author: { _id: string; avatar: FileInformation | null; description: string; displayName: string; username: string; verified: boolean }
    • _id: string
    • avatar: FileInformation | null
    • description: string
    • displayName: string
    • username: string
    • verified: boolean
  • createdAt: number
  • file: FileInformation
  • private: boolean
  • slug: string
  • tags: string[]
  • title: string

PostPopularResponse

PostPopularResponse: PostInPopular[]

PostSearchResponse

PostSearchResponse: { hits: PostInSearch[]; numHits: number; tookMs: number }

Type declaration

SessionCreateResponse

SessionCreateResponse: { sessionName: string; token: string }

Type declaration

  • sessionName: string
  • token: string

SessionCurrentResponse

SessionCurrentResponse: { _id: string; sessionName: string; token: string; userId: string }

Type declaration

  • _id: string
  • sessionName: string
  • token: string
  • userId: string

SessionListResponse

SessionListResponse: Omit<SessionCurrentResponse, "token" | "userId">[]

UserFavoritesResponse

UserFavoritesResponse: FavoriteURL[]

UserQueryResponse

UserQueryResponse: { _id: string; avatar: FileInformation | null; description: string; displayName: string; username: string; verified: boolean }

Type declaration

  • _id: string
  • avatar: FileInformation | null
  • description: string
  • displayName: string
  • username: string
  • verified: boolean

UserRegisterResponse

UserRegisterResponse: { _id: string; avatar: null; description: string; displayName: string; email: string; username: string }

Type declaration

  • _id: string
  • avatar: null
  • description: string
  • displayName: string
  • email: string
  • username: string

UserSelfResponse

UserSelfResponse: { avatar: object | null; description: string; displayName: string; email: string; username: string; verified: boolean }

Type declaration

  • avatar: object | null
  • description: string
  • displayName: string
  • email: string
  • username: string
  • verified: boolean

Generated using TypeDoc