Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Submission

A data container for an event submission

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Submission(__namedParameters?: { contactInfo: undefined | string; contact_info: undefined | string; eventId: undefined | number; event_id: undefined | number; id: undefined | number; location: undefined | string; name: undefined | string; repositoryUrls: undefined | string[]; repository_urls: undefined | string[]; url: undefined | string; userIds: undefined | number[]; user_ids: undefined | number[]; users: undefined | User[] }): Submission

  • Creates a new Submission object

    constructor

    Parameters

    • Default value __namedParameters: { contactInfo: undefined | string; contact_info: undefined | string; eventId: undefined | number; event_id: undefined | number; id: undefined | number; location: undefined | string; name: undefined | string; repositoryUrls: undefined | string[]; repository_urls: undefined | string[]; url: undefined | string; userIds: undefined | number[]; user_ids: undefined | number[]; users: undefined | User[] } = {}
      • contactInfo: undefined | string
      • contact_info: undefined | string
      • eventId: undefined | number
      • event_id: undefined | number
      • id: undefined | number
      • location: undefined | string
      • name: undefined | string
      • repositoryUrls: undefined | string[]
      • repository_urls: undefined | string[]
      • url: undefined | string
      • userIds: undefined | number[]
      • user_ids: undefined | number[]
      • users: undefined | User[]

    Returns Submission

Properties

Optional contactInfo

contactInfo: undefined | string

Optional eventId

eventId: undefined | number

Optional id

id: undefined | number

Optional location

location: undefined | string

Optional name

name: undefined | string

Optional repositoryUrls

repositoryUrls: 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 url

url: undefined | string

Optional userIds

userIds: number[]

Optional users

users: User[]

Methods

toHackerAPIFormat

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

Static create

  • create(__namedParameters: { slug: string | number }, submission: Submission, token?: undefined | string): Promise<{}>

  • Adds a submission to hackerapi

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • submission: Submission

      The submission to push

    • 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: { slug: string | number }, __namedParameters: { id: number }, token?: undefined | string): Promise<null>

  • Deletes a submission

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • __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: { slug: string | number }, __namedParameters: { id: number }, token?: undefined | string): Promise<{}>

  • Fetches a submission on hackerapi

    Parameters

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

    Returns Promise<{}>

Static fetchAll

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

  • Gets all the submissions for an event

    Parameters

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

    Returns Promise<{}[]>

    The list of submissions for the event

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(__namedParameters: { slug: string | number }, submission: Submission, token?: undefined | string): Promise<{}>

  • Updates a submission on hackerapi

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • submission: Submission

      The submission to update

    • Optional token: undefined | string

    Returns Promise<{}>

Generated using TypeDoc