Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pipeline

A data container for a pipeline stage with static methods for interfacing with hackerapi

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Pipeline(__namedParameters: { claims: undefined | number; description: undefined | string; endTime: undefined | Date; end_time: undefined | Date; eventSlug: undefined | string; event_slug: undefined | string; fields: undefined | Field[]; id: undefined | number; maxNumClaims: undefined | number; maxNumCollaborators: undefined | number; max_num_claims: undefined | number; max_num_collaborators: undefined | number; name: undefined | string; permissions: undefined | string[]; relationships: undefined | string[]; slug: undefined | string; stageOrder: undefined | number[]; stage_order: undefined | number[]; stages: undefined | Stage[]; startTime: undefined | Date; start_time: undefined | Date }): Pipeline

  • Parameters

    • __namedParameters: { claims: undefined | number; description: undefined | string; endTime: undefined | Date; end_time: undefined | Date; eventSlug: undefined | string; event_slug: undefined | string; fields: undefined | Field[]; id: undefined | number; maxNumClaims: undefined | number; maxNumCollaborators: undefined | number; max_num_claims: undefined | number; max_num_collaborators: undefined | number; name: undefined | string; permissions: undefined | string[]; relationships: undefined | string[]; slug: undefined | string; stageOrder: undefined | number[]; stage_order: undefined | number[]; stages: undefined | Stage[]; startTime: undefined | Date; start_time: undefined | Date }
      • claims: undefined | number
      • description: undefined | string
      • endTime: undefined | Date
      • end_time: undefined | Date
      • eventSlug: undefined | string
      • event_slug: undefined | string
      • fields: undefined | Field[]
      • id: undefined | number
      • maxNumClaims: undefined | number
      • maxNumCollaborators: undefined | number
      • max_num_claims: undefined | number
      • max_num_collaborators: undefined | number
      • name: undefined | string
      • permissions: undefined | string[]
      • relationships: undefined | string[]
      • slug: undefined | string
      • stageOrder: undefined | number[]
      • stage_order: undefined | number[]
      • stages: undefined | Stage[]
      • startTime: undefined | Date
      • start_time: undefined | Date

    Returns Pipeline

Properties

Optional claims

claims: undefined | number

Optional description

description: undefined | string

Optional endTime

endTime: Date

Optional eventSlug

eventSlug: undefined | string

Optional fields

fields: Field[]

Optional id

id: undefined | number

Optional maxNumClaims

maxNumClaims: number | undefined

Optional maxNumCollaborators

maxNumCollaborators: number | undefined

Optional name

name: undefined | string

Optional permissions

permissions: string[]

Optional relationships

relationships: string[]

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 stageOrder

stageOrder: number[]

Optional stages

stages: Stage[]

Optional startTime

startTime: Date

Accessors

Static Field

Static Stage

Methods

toHackerAPIFormat

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

Static create

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

  • Deletes a pipeline on hackerapi. Note that a pipeline cannot be deleted if it still has claims attached to it.

    Parameters

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

  • Fetches a pipeline from hackerapi.com

    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(pipeline: Pipeline, token?: undefined | string): Promise<{}>

Generated using TypeDoc