Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Team

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Team(__namedParameters?: { createdAt: undefined | Date; created_at: undefined | Date; eventSlug: undefined | string; event_slug: undefined | string; id: undefined | number; members: undefined | Member[]; updatedAt: undefined | Date; updated_at: undefined | Date }): Team

  • Creates a new team instance

    constructor

    Parameters

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

    Returns Team

Properties

Optional createdAt

createdAt: Date

Optional eventSlug

eventSlug: undefined | string

Optional id

id: undefined | number

Optional members

members: Member[]

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

Accessors

Static Member

Methods

toHackerAPIFormat

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

Static create

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

  • Creates a new team for a given event. It adds the person whose token was used to the team as well.

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | 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 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 a team using its id

    Parameters

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

    Returns Promise<{}>

Static fetchAllByUserId

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

  • Fetches all teams that a user is a member of

    Parameters

    • Default value __namedParameters: { id: number | "me" } = { id: "me" }
      • id: number | "me"
    • Optional token: undefined | string

    Returns Promise<{}[]>

Static join

  • join(__namedParameters: { teamId: number }, asUser?: Wild<{ id: UserSlug }>, token?: undefined | string): Promise<{}>

  • Adds a user to a team

    Parameters

    • __namedParameters: { teamId: number }
      • teamId: number
    • Optional asUser: Wild<{ id: UserSlug }>
    • Optional token: undefined | string

    Returns Promise<{}>

Static leave

  • leave(__namedParameters: { teamId: number }, asUser?: Wild<{ id: UserSlug }>, token?: undefined | string): Promise<{}>

  • Removes a user from a team

    Parameters

    • __namedParameters: { teamId: number }
      • teamId: number
    • Optional asUser: Wild<{ id: UserSlug }>
    • 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