Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SearchForm

Hierarchy

  • SearchForm

Implements

Index

Constructors

constructor

Properties

api

api: IApi

data

data: any

form

form: IForm

Methods

fetch

fetchLinks

lang

  • Sets the language to query for this SearchForm. This is an optional method.

    Parameters

    • langCode: string

    Returns ISearchForm

orderings

page

pageSize

  • Sets a page size to query for this SearchForm. This is an optional method.

    Parameters

    • size: number

      The page size

    Returns ISearchForm

    • The SearchForm itself

query

ref

  • Sets a ref to query on for this SearchForm. This is a mandatory method to call before calling submit(), and api.form('everything').submit() will not work.

    Parameters

    • ref: string

    Returns ISearchForm

set

submit

  • submit(callback: function): any
  • Submits the query, and calls the callback function.

    Parameters

    • callback: function
        • (error: Error | null, response: IApiResponse, xhr: any): void
        • Parameters

          Returns void

    Returns any

Generated using TypeDoc