Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Waitlist

Index

Functions

Functions

  • description

    Retrieves a waitlist entry, given its id. Called asynchronously with await. All data is provided as-is from the server, with the addition of an ok boolean for error handling.

    docs

    https://docs.hyper.co/reference/retrieve-waitlist-entry

    example
    import { Client, Waitlist } from 'hyper'
    const client = Hyper('my-api-key')

    let entry = "my-entry-id"

    const res = await Waitlist.get(client, entry)

    Parameters

    • client: HyperApiClient

      (HyperApiClient) The client to use for the request

    • entry: string

      (string) The id of the entry to fetch

    Returns Promise<HyperApiResponse>

    HyperApiResponse

Generated using TypeDoc