Options
All
  • Public
  • Public/Protected
  • All
Menu

External module Utils

Index

Type aliases

Wild

Wild<T>: T & {}

Type parameters

  • T

Functions

camelCase

  • camelCase(str: string): string
  • Converts a variable from underscores to camelcase

    Parameters

    • str: string

    Returns string

parseArray

  • parseArray<T>(underscored?: T[], camelcased?: T[]): T[] | undefined
  • Type parameters

    • T

    Parameters

    • Optional underscored: T[]
    • Optional camelcased: T[]

    Returns T[] | undefined

parseArrayOrNull

  • parseArrayOrNull<T>(underscored?: T[], camelcased?: T[]): T[] | undefined
  • Parses an array or null

    Type parameters

    • T

    Parameters

    • Optional underscored: T[]
    • Optional camelcased: T[]

    Returns T[] | undefined

parseBoolean

  • parseBoolean(underscored: any, camelcased: any): undefined | false | true
  • Parses a boolean field

    Parameters

    • underscored: any
    • camelcased: any

    Returns undefined | false | true

parseDate

  • parseDate(date: string | Date | undefined | null): undefined | Date
  • Parses a date field

    Parameters

    • date: string | Date | undefined | null

    Returns undefined | Date

parseNumber

  • parseNumber(underscored: any, camelcased: any): undefined | number
  • Parses a number field

    Parameters

    • underscored: any

      The hackerapi responses

    • camelcased: any

      The hackerapi.js field

    Returns undefined | number

    The number or undefined if neither format contained a number

parseString

  • parseString(underscored?: undefined | string, camelcased?: undefined | string): string | undefined
  • Parses a string field

    Parameters

    • Optional underscored: undefined | string
    • Optional camelcased: undefined | string

    Returns string | undefined

parseStringOrNull

  • parseStringOrNull(underscored?: string | null, camelcased?: string | null): undefined | string
  • Parses a field that could be a string or null

    Parameters

    • Optional underscored: string | null
    • Optional camelcased: string | null

    Returns undefined | string

parseToken

  • parseToken(token: any): any
  • Parses a token

    Parameters

    • token: any

    Returns any

    Undefined if couldn't parse token

responseToDataUri

  • responseToDataUri(res: any): string
  • Converts a response from hackerapi into a data uri

    Parameters

    • res: any

    Returns string

toUnderscoreKeys

  • toUnderscoreKeys(cc: object): {}
  • Returns a new object with the same data as cc but with keys with underscore naming convention instead of camelcase

    Parameters

    • cc: object

      let cc = { camelCase: true } let u = HackerAPI.Utils.toUnderscoreKeys(cc); // u: { camel_case: true }

    Returns {}

underscores

  • underscores(str: string): string
  • Converts a variable from camelcase to underscores

    Parameters

    • str: string

    Returns string

Generated using TypeDoc