Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FieldAnswer

An answer to a field

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new FieldAnswer(__namedParameters?: { createdAt: undefined | Date; created_at: undefined | Date; fieldId: undefined | number; field_id: undefined | number; meta: any; name: undefined | string; type: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date; value: undefined | string | number | false | true | object }): FieldAnswer

  • Creates a field answer instance

    constructor

    Parameters

    • Default value __namedParameters: { createdAt: undefined | Date; created_at: undefined | Date; fieldId: undefined | number; field_id: undefined | number; meta: any; name: undefined | string; type: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date; value: undefined | string | number | false | true | object } = {}
      • createdAt: undefined | Date
      • created_at: undefined | Date
      • fieldId: undefined | number
      • field_id: undefined | number
      • meta: any
      • name: undefined | string
      • type: undefined | string
      • updatedAt: undefined | Date
      • updated_at: undefined | Date
      • value: undefined | string | number | false | true | object

    Returns FieldAnswer

Properties

Optional createdAt

createdAt: Date

Optional fieldId

fieldId: undefined | number

Optional meta

meta: any

Optional name

name: 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 type

type: undefined | string

Optional updatedAt

updatedAt: Date

Optional value

value: string | boolean | number | object

Methods

toHackerAPIFormat

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

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 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]

Generated using TypeDoc