Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Collaborator

A data container for claim collaborators with static methods for interfacing with hackerapi.com

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Collaborator(__namedParameters: { createdAt: undefined | Date; created_at: undefined | Date; email: undefined | string; gender: undefined | string; github: undefined | string; graduatingYear: undefined | number; id: undefined | number; linkedin: undefined | string; name: undefined | string; portfolio: undefined | string; program: undefined | string; school: undefined | string; skills: undefined | string; user: undefined | User }): Collaborator

  • Creates a new Collaborator instance

    constructor

    Parameters

    • __namedParameters: { createdAt: undefined | Date; created_at: undefined | Date; email: undefined | string; gender: undefined | string; github: undefined | string; graduatingYear: undefined | number; id: undefined | number; linkedin: undefined | string; name: undefined | string; portfolio: undefined | string; program: undefined | string; school: undefined | string; skills: undefined | string; user: undefined | User }
      • createdAt: undefined | Date
      • created_at: undefined | Date
      • email: undefined | string
      • gender: undefined | string
      • github: undefined | string
      • graduatingYear: undefined | number
      • id: undefined | number
      • linkedin: undefined | string
      • name: undefined | string
      • portfolio: undefined | string
      • program: undefined | string
      • school: undefined | string
      • skills: undefined | string
      • user: undefined | User

    Returns Collaborator

Properties

Optional createdAt

createdAt: Date

Optional email

email: undefined | string

Optional gender

gender: undefined | string

Optional github

github: undefined | string

Optional graduatingYear

graduatingYear: undefined | number

Optional id

id: undefined | number

Optional linkedin

linkedin: undefined | string

Optional name

name: undefined | string

Optional portfolio

portfolio: undefined | string

Optional program

program: undefined | string

Optional school

school: undefined | string

Optional skills

skills: undefined | string

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 add

  • add(__namedParameters: { id: number }, token?: undefined | string): Promise<{}>

  • Adds a new collaborator for a claim

    Parameters

    • __namedParameters: { id: number }
      • id: number
    • Optional token: undefined | string

    Returns Promise<{}>

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 delete

  • delete(__namedParameters: { id: number }, collaborator: Collaborator, token?: undefined | string): Promise<any>

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 fetchAll

  • fetchAll(__namedParameters: { id: number }, token?: undefined | string): Promise<{}[]>

  • Fetches all the collaborators for a claim

    Parameters

    • __namedParameters: { id: number }
      • id: number
    • Optional token: undefined | string

    Returns Promise<{}[]>

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