Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Education

A data container for things related to a hacker's education

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Education(__namedParameters: { currentStatus: undefined | null | CurrentStatus; currentYear: undefined | null | number; current_status: undefined | CurrentStatus; current_year: undefined | number; degree: undefined | null | string; graduatingYear: undefined | null | number; graduating_year: undefined | number; institution: undefined | null | string; institutionId: undefined | null | number; institution_id: undefined | number; minor: undefined | null | string; program: undefined | null | string }): Education

  • Creates a new Education instance

    constructor

    Parameters

    • __namedParameters: { currentStatus: undefined | null | CurrentStatus; currentYear: undefined | null | number; current_status: undefined | CurrentStatus; current_year: undefined | number; degree: undefined | null | string; graduatingYear: undefined | null | number; graduating_year: undefined | number; institution: undefined | null | string; institutionId: undefined | null | number; institution_id: undefined | number; minor: undefined | null | string; program: undefined | null | string }
      • currentStatus: undefined | null | CurrentStatus
      • currentYear: undefined | null | number
      • current_status: undefined | CurrentStatus
      • current_year: undefined | number
      • degree: undefined | null | string
      • graduatingYear: undefined | null | number
      • graduating_year: undefined | number
      • institution: undefined | null | string
      • institutionId: undefined | null | number
      • institution_id: undefined | number
      • minor: undefined | null | string
      • program: undefined | null | string

    Returns Education

Properties

currentStatus

currentStatus: CurrentStatus | null

currentYear

currentYear: number | null

degree

degree: string | null

graduatingYear

graduatingYear: number | null

institution

institution: string | null

institutionId

institutionId: number | null

minor

minor: string | null

program

program: string | null

specialHandlers

specialHandlers: {}

Type declaration

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

      • Parameters

        • Rest ...args: unknown[]

        Returns [string, undefined | string]

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