Param | @uirouter/core
Options
Menu

Class Param

Hierarchy

  • Param

Index

Constructors

Properties

Methods

Constructors

Properties

_defaultValueCache: object

Cache the default value if it is a static value

Cache the default value if it is a static value

Type declaration

  • defaultValue: any
array: boolean
config: any
dynamic: boolean
id: string
inherit: boolean
isOptional: boolean
location: DefType.PATH | DefType.SEARCH | DefType.CONFIG
raw: boolean
replace: [object]
squash: string | true | false
type: ParamType

Methods

  • isDefaultValue(value: any): boolean
  • isSearch(): boolean
  • toString(): string
  • validates(value: any): boolean
  • value(value?: any): any

  • [Internal] Gets the decoded representation of a value if the value is defined, otherwise, returns the default value, which may be the result of an injectable function.

  • [Internal] Gets the decoded representation of a value if the value is defined, otherwise, returns the default value, which may be the result of an injectable function.

    Parameters

    • value: Optional  any

    Returns any

  • changed(params: Param[], values1?: RawParams, values2?: RawParams): Param[]

  • Finds Param objects which have different param values

  • Finds Param objects which have different param values

    Filters a list of Param objects to only those whose parameter values differ in two param value objects

    Parameters

    • params Param[]
    • values1: Default value  RawParams = {}
    • values2: Default value  RawParams = {}

    Returns Param[]

    :

    any Param objects whose values were different between values1 and values2

  • equals(params: Param[], values1?: object, values2?: object): boolean

  • Checks if two param value objects are equal (for a set of Param objects)

  • Checks if two param value objects are equal (for a set of Param objects)

    Parameters

    • params Param[]
      :

      The list of Param objects to check

    • values1: Default value  object = {}
      :

      The first set of param values

    • values2: Default value  object = {}
      :

      The second set of param values

    Returns boolean

    :

    true if the param values in values1 and values2 are equal

  • validates(params: Param[], values?: RawParams): boolean

  • Returns true if a the parameter values are valid, according to the Param definitions

  • Returns true if a the parameter values are valid, according to the Param definitions

    Parameters

    • params Param[]
    • values: Default value  RawParams = {}

    Returns boolean

Generated using TypeDoc