Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EmergencyContact

A data container for information related to an emergency contact of a user

class
extends

{ HackerAPI.Base }

Hierarchy

  • Base
    • EmergencyContact

Index

Constructors

Properties

Methods

Constructors

constructor

  • new EmergencyContact(__namedParameters: { address: undefined | null | Address; email: string; name: string; phoneNumber: undefined | null | string; phone_number: undefined | string; relationship: undefined | null | string }): EmergencyContact

  • Creates a new EmergencyContact instance

    constructor

    Parameters

    • __namedParameters: { address: undefined | null | Address; email: string; name: string; phoneNumber: undefined | null | string; phone_number: undefined | string; relationship: undefined | null | string }
      • address: undefined | null | Address
      • email: string
      • name: string
      • phoneNumber: undefined | null | string
      • phone_number: undefined | string
      • relationship: undefined | null | string

    Returns EmergencyContact

Properties

address

address: Address | null

email

email: string

name

name: string

phoneNumber

phoneNumber: string | null

relationship

relationship: 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