@oarepo/vue-query-synchronizer
Options
All
  • Public
  • Public/Protected
  • All
Menu

This is the type of the return value of useQuery() if not specified otherwise

Hierarchy

Index

Methods

Methods

addValue

  • addValue(key: string, value: any, datatype?: DataType<any>): void

  • Adds a value to array parameter, making sure that it is added only once

    Parameters

    • key: string

      name of the URL parameter

    • value: any

      the value

    • Optional datatype: DataType<any>

      optional datatype, used only if the parameter's datatype is not yet an array

    Returns void

define

  • define(key: string, datatype: DataType<any>, defaultValue: any): void

  • Dynamically add a new query parameter. If the parameter is already known, its datatype will be replaced and the parameter will be parsed again.

    Parameters

    • key: string

      name of the URL parameter

    • datatype: DataType<any>

      datatype of the parameter

    • defaultValue: any

      the default value

    Returns void

removeValue

  • removeValue(key: string, value: any, datatype?: DataType<any>): void

  • Removes a value from array parameter

    Parameters

    • key: string

      name of the URL parameter

    • value: any

      the value

    • Optional datatype: DataType<any>

      optional datatype, used only if the parameter's datatype is not yet an array

    Returns void

Legend

  • Property
  • Method

Generated using TypeDoc