Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Review

A data container for review related information with static methods for interfacing with hackerapi.com

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Review(__namedParameters?: { history: undefined | string[]; id: undefined | number; note: undefined | string; reviewerId: undefined | number; reviewerName: undefined | string; reviewer_id: undefined | number; reviewer_name: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date }): Review

  • Instantiates a new instance of a review

    constructor

    Parameters

    • Default value __namedParameters: { history: undefined | string[]; id: undefined | number; note: undefined | string; reviewerId: undefined | number; reviewerName: undefined | string; reviewer_id: undefined | number; reviewer_name: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date } = {}
      • history: undefined | string[]
      • id: undefined | number
      • note: undefined | string
      • reviewerId: undefined | number
      • reviewerName: undefined | string
      • reviewer_id: undefined | number
      • reviewer_name: undefined | string
      • updatedAt: undefined | Date
      • updated_at: undefined | Date

    Returns Review

Properties

Optional history

history: string[]

Optional id

id: undefined | number

Optional note

note: undefined | string

Optional reviewerId

reviewerId: undefined | number

Optional reviewerName

reviewerName: undefined | string

specialHandlers

specialHandlers: {}

Type declaration

  • [key: string]: (...args: unknown[]) => [string, undefined | string]
      • (...args: unknown[]): [string, undefined | string]

      • Parameters

        • Rest ...args: unknown[]

        Returns [string, undefined | string]

Optional updatedAt

updatedAt: Date

Methods

toHackerAPIFormat

  • toHackerAPIFormat(method?: undefined | string): {}

Static add

  • add(__namedParameters: { id: number }, review: Review, token?: undefined | string): Promise<{}>

  • Adds a new review to a claim

    Parameters

    • __namedParameters: { id: number }
      • id: number
    • review: Review
    • Optional token: undefined | string

    Returns Promise<{}>

Static dateHandler

  • dateHandler(key: string, date: string | Date): string[]

  • Converts a Javascript date (where only day, month and year are relevant) to a format understood by hackerapi

    Parameters

    • key: string
    • date: string | Date

      Doesn't do anything if string

    Returns string[]

    key: [0], value: [1]

Static dateTimeHandler

  • dateTimeHandler(key: string, datetime: string | Date): string[]

  • Converts Javascript date to a format understood by hackerapi

    Parameters

    • key: string
    • datetime: string | Date

    Returns string[]

    key: [0], value: [1]

Static doNotSendHandler

  • doNotSendHandler(key: string, _: any): (undefined | string)[]

  • Does not send the field to hackerapi

    Parameters

    • key: string
    • _: any

    Returns (undefined | string)[]

    key: [0], value: [1]

Static fetch

  • fetch(__namedParameters: { claimId: number }, __namedParameters: { reviewId: number }, token?: undefined | string): Promise<{}>

  • Fetches a review from hackerapi

    Parameters

    • __namedParameters: { claimId: number }
      • claimId: number
    • __namedParameters: { reviewId: number }
      • reviewId: number
    • Optional token: undefined | string

    Returns Promise<{}>

Static renameHandler

  • renameHandler(renamedKey: string): (Anonymous function)

  • HOC for renaming a field before sending it to hackerapi

    Parameters

    • renamedKey: string

      The string to rename the key to

    Returns (Anonymous function)

    key: [0], value: [1]

Static update

  • update(__namedParameters: { id: number }, review: Review, token?: undefined | string): Promise<{}>

  • Updates a review to a claim

    Parameters

    • __namedParameters: { id: number }
      • id: number
    • review: Review
    • Optional token: undefined | string

    Returns Promise<{}>

Generated using TypeDoc