Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Organization

A data container with an organization with static methods for interfacing with hackerapi

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Organization(__namedParameters?: { createdAt: undefined | Date; created_at: undefined | Date; events: undefined | Event[]; id: undefined | number; members: undefined | Member[]; name: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date }): Organization

  • Creates an instance of an organization

    constructor

    Parameters

    • Default value __namedParameters: { createdAt: undefined | Date; created_at: undefined | Date; events: undefined | Event[]; id: undefined | number; members: undefined | Member[]; name: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date } = {}
      • createdAt: undefined | Date
      • created_at: undefined | Date
      • events: undefined | Event[]
      • id: undefined | number
      • members: undefined | Member[]
      • name: undefined | string
      • updatedAt: undefined | Date
      • updated_at: undefined | Date

    Returns Organization

Properties

Optional createdAt

createdAt: Date

Optional events

events: Event[]

Optional id

id: undefined | number

Optional members

members: Member[]

Optional name

name: 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]

Optional updatedAt

updatedAt: Date

Methods

toHackerAPIFormat

  • toHackerAPIFormat(method?: undefined | string): {}

Static addEvent

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

  • Attaches an event to an organization

    Parameters

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

    Returns Promise<{}>

Static addMember

  • addMember(__namedParameters: { orgId: number }, __namedParameters: { userId: number }, token?: undefined | string): Promise<{}>

  • Associates a user with an organization

    Parameters

    • __namedParameters: { orgId: number }
      • orgId: number
    • __namedParameters: { userId: number }
      • userId: number
    • Optional token: undefined | string

    Returns Promise<{}>

Static create

  • create(org: Organization, token?: undefined | string): 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 }, token?: undefined | string): Promise<null>

  • Deletes an organization

    Parameters

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

    Returns Promise<null>

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 fetch

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

  • Fetches an organization

    Parameters

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

    Returns Promise<{}>

Static removeEvent

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

  • Disassociates an event from an organization

    Parameters

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

    Returns Promise<{}>

Static removeMember

  • removeMember(__namedParameters: { orgId: number }, __namedParameters: { userId: number }, token?: undefined | string): Promise<null>

  • Disassociates a user from an organization

    Parameters

    • __namedParameters: { orgId: number }
      • orgId: number
    • __namedParameters: { userId: number }
      • userId: number
    • Optional token: undefined | string

    Returns Promise<null>

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]

Static update

  • update(org: Organization, token?: undefined | string): Promise<{}>

Generated using TypeDoc