Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Address

A data container for an address

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Address(__namedParameters?: { city: undefined | string; country: undefined | string; countryCode: undefined | string; country_code: undefined | string; latitude: undefined | number; line1: undefined | string; line2: undefined | string; line3: undefined | string; line_1: undefined | string; line_2: undefined | string; line_3: undefined | string; longitude: undefined | number; stateProvince: undefined | string; state_province: undefined | string; zipPostalCode: undefined | string; zip_postal_code: undefined | string }): Address

  • Creates a new Address instance

    Parameters

    • Default value __namedParameters: { city: undefined | string; country: undefined | string; countryCode: undefined | string; country_code: undefined | string; latitude: undefined | number; line1: undefined | string; line2: undefined | string; line3: undefined | string; line_1: undefined | string; line_2: undefined | string; line_3: undefined | string; longitude: undefined | number; stateProvince: undefined | string; state_province: undefined | string; zipPostalCode: undefined | string; zip_postal_code: undefined | string } = {}
      • city: undefined | string
      • country: undefined | string
      • countryCode: undefined | string
      • country_code: undefined | string
      • latitude: undefined | number
      • line1: undefined | string
      • line2: undefined | string
      • line3: undefined | string
      • line_1: undefined | string
      • line_2: undefined | string
      • line_3: undefined | string
      • longitude: undefined | number
      • stateProvince: undefined | string
      • state_province: undefined | string
      • zipPostalCode: undefined | string
      • zip_postal_code: undefined | string

    Returns Address

Properties

Optional city

city: undefined | string

Optional country

country: undefined | string

Optional countryCode

countryCode: undefined | string

Optional latitude

latitude: undefined | number

Optional line1

line1: undefined | string

Optional line2

line2: undefined | string

Optional line3

line3: undefined | string

Optional longitude

longitude: undefined | number

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 stateProvince

stateProvince: undefined | string

Optional zipPostalCode

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