Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MailingListSignup

A container for data related to a mailing list signup for an event.

class
extends

{ HackerAPI.Base }

Hierarchy

  • Base
    • MailingListSignup

Index

Constructors

Properties

Methods

Constructors

constructor

  • new MailingListSignup(__namedParameters?: { alreadySignedUp: undefined | false | true; already_signed_up: undefined | false | true; createdAt: undefined | Date; created_at: undefined | Date; email: undefined | string; id: undefined | number; name: undefined | string }): MailingListSignup

  • Creates a new MailingListSignup object

    Parameters

    • Default value __namedParameters: { alreadySignedUp: undefined | false | true; already_signed_up: undefined | false | true; createdAt: undefined | Date; created_at: undefined | Date; email: undefined | string; id: undefined | number; name: undefined | string } = {}
      • alreadySignedUp: undefined | false | true
      • already_signed_up: undefined | false | true
      • createdAt: undefined | Date
      • created_at: undefined | Date
      • email: undefined | string
      • id: undefined | number
      • name: undefined | string

    Returns MailingListSignup

Properties

Optional alreadySignedUp

alreadySignedUp: undefined | false | true

Optional createdAt

createdAt: Date

Optional email

email: undefined | string

Optional id

id: undefined | number

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]

Methods

toHackerAPIFormat

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

Static create

  • create(__namedParameters: { slug: string | number }, signup: MailingListSignup): 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 fetchAll

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