Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Field

A data container for data related to a pipeline field with static methods for interfacing with hackerapi

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Field(__namedParameters: { createdAt: undefined | Date; created_at: undefined | Date; fieldType: undefined | string; field_type: undefined | string; id: undefined | number; isRequired: undefined | false | true; is_required: undefined | false | true; name: undefined | string; permissions: any; slug: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date; validValues: undefined | any[]; valid_values: undefined | any[] }): Field

  • Creates a field instance

    Parameters

    • __namedParameters: { createdAt: undefined | Date; created_at: undefined | Date; fieldType: undefined | string; field_type: undefined | string; id: undefined | number; isRequired: undefined | false | true; is_required: undefined | false | true; name: undefined | string; permissions: any; slug: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date; validValues: undefined | any[]; valid_values: undefined | any[] }
      • createdAt: undefined | Date
      • created_at: undefined | Date
      • fieldType: undefined | string
      • field_type: undefined | string
      • id: undefined | number
      • isRequired: undefined | false | true
      • is_required: undefined | false | true
      • name: undefined | string
      • permissions: any
      • slug: undefined | string
      • updatedAt: undefined | Date
      • updated_at: undefined | Date
      • validValues: undefined | any[]
      • valid_values: undefined | any[]

    Returns Field

Properties

Optional createdAt

createdAt: Date

Optional fieldType

fieldType: undefined | string

Optional id

id: undefined | number

Optional isRequired

isRequired: undefined | false | true

Optional name

name: undefined | string

Optional permissions

permissions: any

Optional slug

slug: 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

Optional validValues

validValues: any[] | undefined

Methods

toHackerAPIFormat

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

Static create

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

  • Creates a field for a pipeline

    Parameters

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

  • Deletes a field for a pipeline

    Parameters

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

  • Fetches a field for a pipeline

    Parameters

    • __namedParameters: { pipelineId: string | number }
      • pipelineId: string | number
    • __namedParameters: { fieldId: string | number }
      • fieldId: string | number
    • Optional token: undefined | string

    Returns Promise<{}>

Static fetchAll

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

  • Fetches all the fields for a pipeline

    Parameters

    • __namedParameters: { id: string | number }
      • id: string | 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]

Static update

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

  • Updates a field for a pipeline

    Parameters

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

    Returns Promise<{}>

Generated using TypeDoc