Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Search

A static class with methods for searching various parts of the hackerapi database

class

Hierarchy

  • Search

Index

Accessors

Methods

Accessors

Static Airport

Static User

Methods

Static airports

  • airports(query: Wild<{ q: string }>): Promise<{}[]>

  • Searches the airport database with the given query string

    Parameters

    • query: Wild<{ q: string }>

    Returns Promise<{}[]>

Static claims

  • claims(query: Wild<{ event?: undefined | string; pipeline?: string | number; q?: undefined | string }>, token?: undefined | string): Promise<{}[]>

  • Searches the claim database for claims matching the query parameters

    Parameters

    • query: Wild<{ event?: undefined | string; pipeline?: string | number; q?: undefined | string }>
    • Optional token: undefined | string

    Returns Promise<{}[]>

Static companies

  • companies(query: Wild<{ q: string }>): Promise<{}[]>

  • Searches the company database for companies matching the query parameters

    Parameters

    • query: Wild<{ q: string }>

    Returns Promise<{}[]>

Static events

  • events(query: Wild<{ q: string }>): Promise<{}[]>

  • Searches the event database for events matching the query parameters

    Parameters

    • query: Wild<{ q: string }>

    Returns Promise<{}[]>

    Only returns id, slug, name, startTime, endTime, website, createdAt and updatedAt fields

Static institutions

  • institutions(query: Wild<{ countryCode?: undefined | string; institutionType?: undefined | string; q?: undefined | string }>): Promise<{}[]>

  • Searches the school database with some or all of the query parameters

    Parameters

    • query: Wild<{ countryCode?: undefined | string; institutionType?: undefined | string; q?: undefined | string }>

    Returns Promise<{}[]>

    Note doesn't return address

Static teams

  • teams(query: Wild<{ event?: undefined | string; page?: undefined | number; size?: undefined | number; teamId?: undefined | number; userId?: undefined | number }>, token?: undefined | string): Promise<{}[]>

  • Searches the team database for teams matching the query parameters

    Parameters

    • query: Wild<{ event?: undefined | string; page?: undefined | number; size?: undefined | number; teamId?: undefined | number; userId?: undefined | number }>
    • Optional token: undefined | string

    Returns Promise<{}[]>

Static users

  • users(query: Wild<{ q: string }>, token?: undefined | string): Promise<{}[]>

  • Searches the user database for users matching the query string

    Parameters

    • query: Wild<{ q: string }>
    • Optional token: undefined | string

    Returns Promise<{}[]>

Static withSql

  • withSql<T>(query: Wild<{ sql: string }>): Promise<T>

  • Perform an SQL query on the hackerapi database

    Type parameters

    • T

    Parameters

    • query: Wild<{ sql: string }>

    Returns Promise<T>

    The results of the query

Generated using TypeDoc