Param | @uirouter/core
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Param

Hierarchy

  • Param

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_defaultValueCache

_defaultValueCache: { defaultValue: any }

Cache the default value if it is a static value

Type declaration

  • defaultValue: any

array

array: boolean

config

config: any

dynamic

dynamic: boolean

id

id: string

inherit

inherit: boolean

isOptional

isOptional: boolean

location

location: DefType

raw

raw: boolean

replace

replace: [{ from: any; to: any }]

squash

squash: boolean | string

type

type: ParamType

Methods

isDefaultValue

  • isDefaultValue(value: any): boolean

isSearch

  • isSearch(): boolean

toString

  • toString(): string

validates

  • validates(value: any): boolean

value

  • 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.

    Parameters

    • Optional value: any

    Returns any

Static changed

  • 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

    Returns Param[]

    any Param objects whose values were different between values1 and values2

Static equals

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

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

    Parameters

    • params: Param[]

      The list of Param objects to check

    • Default value values1: {} = {}

      The first set of param values

    • Default value values2: {} = {}

      The second set of param values

    Returns boolean

    true if the param values in values1 and values2 are equal

Static validates

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

    Parameters

    Returns boolean

Static values

Generated using TypeDoc