Class Hacker

A data container for things related to a hacker at an event

struct
extends: { HackerAPI.Base }

Hierarchy

Base
- Hacker

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Hacker(__namedParameters?: { education: undefined | null | Education; hackathons: undefined | null | (Event & { endTime: Date; id: number; name: string; slug: string; startTime: Date })[]; schoolEmail: undefined | null | string; school_email: undefined | string; skills: undefined | null | string[]; travel: undefined | null | TravelInfo; urls: undefined | null | Urls }): Hacker

Overrides Base.constructor
- Defined in user/hacker/hacker.ts:51
Creates a new Hacker instance

constructor

Parameters
- Default value __namedParameters: { education: undefined | null | Education; hackathons: undefined | null | (Event & { endTime: Date; id: number; name: string; slug: string; startTime: Date })[]; schoolEmail: undefined | null | string; school_email: undefined | string; skills: undefined | null | string[]; travel: undefined | null | TravelInfo; urls: undefined | null | Urls } = {}
  - education: undefined | null | Education
  - hackathons: undefined | null | (Event & { endTime: Date; id: number; name: string; slug: string; startTime: Date })[]
  - schoolEmail: undefined | null | string
  - school_email: undefined | string
  - skills: undefined | null | string[]
  - travel: undefined | null | TravelInfo
  - urls: undefined | null | Urls
Returns Hacker

Properties

education

education: Education | null

hackathons

hackathons: Hackathon[] | null

schoolEmail

schoolEmail: string | null

skills

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

travel

travel: TravelInfo | null

urls

urls: Urls | null

Accessors

Static Education

get Education(): Education

- Defined in user/hacker/hacker.ts:42
Returns Education

Static TravelInfo

get TravelInfo(): TravelInfo

- Defined in user/hacker/hacker.ts:49
Returns TravelInfo

Static Urls

get Urls(): Urls

- Defined in user/hacker/hacker.ts:35
Returns Urls

Methods

toHackerAPIFormat

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

Inherited from Base.toHackerAPIFormat
- Defined in base/base.ts:88
Converts an object to hackerapi object notation

Parameters
- Optional method: undefined | string
Returns {}
- [key: string]: JSONObject

Static dateHandler

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

Inherited from Base.dateHandler
- Defined in base/base.ts:29
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[]

Inherited from Base.dateTimeHandler
- Defined in base/base.ts:42
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)[]

Inherited from Base.doNotSendHandler
- Defined in base/base.ts:56
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)

Inherited from Base.renameHandler
- Defined in base/base.ts:69
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