Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Faq

A data container for a FAQ related to an event

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Faq(__namedParameters?: { answer: undefined | string; category: undefined | string; createdAt: undefined | Date; created_at: undefined | Date; id: undefined | number; links: undefined | string[]; question: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date }): Faq

  • Creates a new faq

    constructor

    Parameters

    • Default value __namedParameters: { answer: undefined | string; category: undefined | string; createdAt: undefined | Date; created_at: undefined | Date; id: undefined | number; links: undefined | string[]; question: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date } = {}
      • answer: undefined | string
      • category: undefined | string
      • createdAt: undefined | Date
      • created_at: undefined | Date
      • id: undefined | number
      • links: undefined | string[]
      • question: undefined | string
      • updatedAt: undefined | Date
      • updated_at: undefined | Date

    Returns Faq

Properties

Optional answer

answer: undefined | string

Optional category

category: undefined | string

Optional createdAt

createdAt: Date

Optional id

id: undefined | number

Optional links

links: string[]

Optional question

question: 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 create

  • create(__namedParameters: { slug: string | number }, faq: Faq, token?: undefined | string): Promise<{}>

  • Adds a faq to an event

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • faq: Faq

      The faq to add

    • Optional token: undefined | string

    Returns Promise<{}>

    The added faq

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 deleteFaq

  • deleteFaq(__namedParameters: { slug: string | number }, __namedParameters: { id: number }, token?: undefined | string): Promise<null>

  • Deletes a faq

    Parameters

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

    Returns Promise<null>

    Doesn't resolve with a value

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 fetchAll

  • fetchAll(__namedParameters: { slug: string | number }): Promise<{}[]>

  • Gets the faqs for an event

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number

    Returns Promise<{}[]>

    The faqs

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 updateFaq

  • updateFaq(__namedParameters: { slug: string | number }, faq: Faq, token?: undefined | string): Promise<{}>

  • Updates a faq

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • faq: Faq

      The faq to update

    • Optional token: undefined | string

    Returns Promise<{}>

    The updated faq

Generated using TypeDoc