User | HackerAPI JS

Data container for user data with static methods for interfacing with hackerapi

class
extends: { HackerAPI.Base }

Hierarchy

Base
- User

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new User(__namedParameters?: { address: undefined | AddressList; age: undefined | null | number; allergies: undefined | string[]; avatar: undefined | null | string; bio: undefined | null | string; createdAt: undefined | Date; created_at: undefined | Date; dateOfBirth: undefined | null | string; date_of_birth: undefined | string; email: undefined | string; emergencyContact: undefined | null | EmergencyContact; emergency_contact: undefined | EmergencyContact; ethnicity: undefined | null | string; eventRoles: undefined | Attendee[]; event_roles: undefined | Attendee[]; foodRestrictions: undefined | string[]; food_restrictions: undefined | string[]; gender: undefined | null | MALE | FEMALE | PREFER_NOT_TO_SPECIFY | OTHER; id: undefined | number; legalName: undefined | null | string; legal_name: undefined | string; name: undefined | string; nativeLanguage: undefined | null | string; native_language: undefined | string; organizations: undefined | Organization[]; phoneNumber: undefined | null | string; phone_number: undefined | string; roles: undefined | RoleList; shirtSize: undefined | null | number; shirt_size: undefined | number; updatedAt: undefined | Date; updated_at: undefined | Date }): User

Overrides Base.constructor
- Defined in user/user.ts:105
Creates a new User instance

constructor

Parameters
- Default value __namedParameters: { address: undefined | AddressList; age: undefined | null | number; allergies: undefined | string[]; avatar: undefined | null | string; bio: undefined | null | string; createdAt: undefined | Date; created_at: undefined | Date; dateOfBirth: undefined | null | string; date_of_birth: undefined | string; email: undefined | string; emergencyContact: undefined | null | EmergencyContact; emergency_contact: undefined | EmergencyContact; ethnicity: undefined | null | string; eventRoles: undefined | Attendee[]; event_roles: undefined | Attendee[]; foodRestrictions: undefined | string[]; food_restrictions: undefined | string[]; gender: undefined | null | MALE | FEMALE | PREFER_NOT_TO_SPECIFY | OTHER; id: undefined | number; legalName: undefined | null | string; legal_name: undefined | string; name: undefined | string; nativeLanguage: undefined | null | string; native_language: undefined | string; organizations: undefined | Organization[]; phoneNumber: undefined | null | string; phone_number: undefined | string; roles: undefined | RoleList; shirtSize: undefined | null | number; shirt_size: undefined | number; updatedAt: undefined | Date; updated_at: undefined | Date } = {}
  - address: undefined | AddressList
  - age: undefined | null | number
  - allergies: undefined | string[]
  - avatar: undefined | null | string
  - bio: undefined | null | string
  - createdAt: undefined | Date
  - created_at: undefined | Date
  - dateOfBirth: undefined | null | string
  - date_of_birth: undefined | string
  - email: undefined | string
  - emergencyContact: undefined | null | EmergencyContact
  - emergency_contact: undefined | EmergencyContact
  - ethnicity: undefined | null | string
  - eventRoles: undefined | Attendee[]
  - event_roles: undefined | Attendee[]
  - foodRestrictions: undefined | string[]
  - food_restrictions: undefined | string[]
  - gender: undefined | null | MALE | FEMALE | PREFER_NOT_TO_SPECIFY | OTHER
  - id: undefined | number
  - legalName: undefined | null | string
  - legal_name: undefined | string
  - name: undefined | string
  - nativeLanguage: undefined | null | string
  - native_language: undefined | string
  - organizations: undefined | Organization[]
  - phoneNumber: undefined | null | string
  - phone_number: undefined | string
  - roles: undefined | RoleList
  - shirtSize: undefined | null | number
  - shirt_size: undefined | number
  - updatedAt: undefined | Date
  - updated_at: undefined | Date
Returns User

Properties

Optional address

address: AddressList

Optional age

age: number | null

Optional allergies

allergies: string[]

Optional avatar

avatar: string | null

Optional bio

bio: string | null

Optional createdAt

createdAt: Date

Optional dateOfBirth

dateOfBirth: string | null

Optional email

email: undefined | string

Optional emergencyContact

emergencyContact: EmergencyContact | null

Optional ethnicity

ethnicity: string | null

Optional eventRoles

eventRoles: Attendee[]

Optional foodRestrictions

foodRestrictions: string[]

Optional gender

gender: Gender | null

Optional id

id: undefined | number

Optional legalName

legalName: string | null

Optional name

name: undefined | string

Optional nativeLanguage

nativeLanguage: string | null

Optional organizations

organizations: Organization[]

Optional phoneNumber

phoneNumber: string | null

Optional roles

roles: RoleList

Optional shirtSize

shirtSize: number | 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]

Optional updatedAt

updatedAt: Date

Accessors

Static AddressList

get AddressList(): AddressList

- Defined in user/user.ts:54
Returns AddressList

Static EmergencyContact

get EmergencyContact(): EmergencyContact

- Defined in user/user.ts:61
Returns EmergencyContact

Static Gender

get Gender(): Gender

- Defined in user/user.ts:68
Returns Gender

Static Hacker

get Hacker(): Hacker

- Defined in user/user.ts:75
Returns Hacker

Static MailEvent

get MailEvent(): MailEvent

- Defined in user/user.ts:103
Returns MailEvent

Static Mentor

get Mentor(): Mentor

- Defined in user/user.ts:82
Returns Mentor

Static RoleList

get RoleList(): RoleList

- Defined in user/user.ts:89
Returns RoleList

Static Sponsor

get Sponsor(): Sponsor

- Defined in user/user.ts:96
Returns Sponsor

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 create

create(user: User & { password?: undefined | string }, __namedParameters: { password: string }): Promise<{}>

- Defined in user/user.ts:412
Creates a new user on hackerapi

Parameters
- user: User & { password?: undefined | string }
- __namedParameters: { password: string }
  - password: string
Returns Promise<{}>

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 delete

delete(__namedParameters: { id: number | "me" }, token?: undefined | string): Promise<null>

- Defined in user/user.ts:462
Deletes a user from hackerapi

Parameters
- __namedParameters: { id: number | "me" }
  - id: number | "me"
- Optional token: undefined | string
Returns Promise<null>

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 fetch

fetch(__namedParameters?: { id: number | "me" }, token?: undefined | string): Promise<{}>

- Defined in user/user.ts:311
Fetches a user from hackerapi

Parameters
- Default value __namedParameters: { id: number | "me" } = { id: "me" }
  - id: number | "me"
- Optional token: undefined | string
Returns Promise<{}>

Static fetchBadge

fetchBadge(__namedParameters?: { id: number | "me" }, role?: string, token?: undefined | string): Promise<string>

- Defined in user/user.ts:361
Fetches a user's badge for the event as a data uri

Parameters
- Default value __namedParameters: { id: number | "me" } = { id: "me" }
  - id: number | "me"
- Default value role: string = "hacker"
  
  The user's role at the event
- Optional token: undefined | string
Returns Promise<string>

Static fetchFiles

fetchFiles(...args: Parameters<typeof fetchAllByUserId>): Promise<{}>

- Defined in user/user.ts:350
Fetches all the files belonging to a user, applying the appropriate filters

see

HackerAPI.File.fetchAllByUserId - This is just a wrapper function

Parameters
- Rest ...args: Parameters<typeof fetchAllByUserId>
Returns Promise<{}>

Static fetchSlackId

fetchSlackId(__namedParameters?: { id: number | "me" }, token?: undefined | string): Promise<string>

- Defined in user/user.ts:328
Fetches the slack ID of a user

throws

{ HackerAPI.Error } - Throws an error if the user hasn't joined slack

todo

Better error handling for 404s

Parameters
- Default value __namedParameters: { id: number | "me" } = { id: "me" }
  - id: number | "me"
- Optional token: undefined | string
Returns Promise<string>

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]

Static update

update(user: User, token?: undefined | string): Promise<{}>

- Defined in user/user.ts:431
Updates a user on hackerapi

Parameters
- user: User
- Optional token: undefined | string
Returns Promise<{}>

Static updateMe

updateMe(user: User, token?: undefined | string): Promise<{}>

- Defined in user/user.ts:446
Updates a user on hackerapi based on the token they authenticate with

Parameters
- user: User
- Optional token: undefined | string
Returns Promise<{}>

Static uploadAvatar

uploadAvatar(__namedParameters?: { id: number | "me" }, formData: { file: string | Blob; type: string } | FormData, token?: undefined | string): Promise<File>

- Defined in user/user.ts:386
Uploads an avatar for the user

todo

Test this bad boy

Parameters
- Default value __namedParameters: { id: number | "me" } = { id: "me" }
  - id: number | "me"
- formData: { file: string | Blob; type: string } | FormData
- Optional token: undefined | string
Returns Promise<File>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: undefined | AddressList

age: undefined | null | number

allergies: undefined | string[]

avatar: undefined | null | string

bio: undefined | null | string

createdAt: undefined | Date

created_at: undefined | Date

dateOfBirth: undefined | null | string

date_of_birth: undefined | string

email: undefined | string

emergencyContact: undefined | null | EmergencyContact

emergency_contact: undefined | EmergencyContact

ethnicity: undefined | null | string

eventRoles: undefined | Attendee[]

event_roles: undefined | Attendee[]

foodRestrictions: undefined | string[]

food_restrictions: undefined | string[]

gender: undefined | null | MALE | FEMALE | PREFER_NOT_TO_SPECIFY | OTHER

id: undefined | number

legalName: undefined | null | string

legal_name: undefined | string

name: undefined | string

nativeLanguage: undefined | null | string

native_language: undefined | string

organizations: undefined | Organization[]

phoneNumber: undefined | null | string

phone_number: undefined | string

roles: undefined | RoleList

shirtSize: undefined | null | number

shirt_size: undefined | number

updatedAt: undefined | Date

updated_at: undefined | Date

Returns User

Properties

Optional address

Optional age

Optional allergies

Optional avatar

Optional bio

Optional createdAt

Optional dateOfBirth

Optional email

Optional emergencyContact

Optional ethnicity

Optional eventRoles

Optional foodRestrictions

Optional gender

Optional id

Optional legalName

Optional name

Optional nativeLanguage

Optional organizations

Optional phoneNumber

Optional roles

Optional shirtSize

specialHandlers

Type declaration

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

Parameters

Rest ...args: unknown[]

Returns [string, undefined | string]

Optional updatedAt

Accessors

Static AddressList

Returns AddressList

Static EmergencyContact

Returns EmergencyContact

Static Gender

Returns Gender

Static Hacker

Returns Hacker