StateBuilder | @uirouter/core
Options
Menu

Class StateBuilder

Hierarchy

  • StateBuilder

Index

Constructors

Properties

Methods

Constructors

Properties

builders: Builders

An object that contains all the BuilderFunctions registered, key'd by the name of the State property they build

An object that contains all the BuilderFunctions registered, key'd by the name of the State property they build

matcher: StateMatcher

Methods

  • build(state: StateObject): StateObject

  • Builds all of the properties on an essentially blank State object, returning a State object which has all its properties and API built.

  • Builds all of the properties on an essentially blank State object, returning a State object which has all its properties and API built.

    Parameters

    Returns StateObject

    :

    the built State object

  • builder(name: string, fn: BuilderFunction): Function | function | function[]

  • Registers a BuilderFunction for a specific StateObject property (e.g., parent, url, or path). More than one BuilderFunction can be registered for a given property.

  • Registers a BuilderFunction for a specific StateObject property (e.g., parent, url, or path). More than one BuilderFunction can be registered for a given property.

    The BuilderFunction(s) will be used to define the property on any subsequently built StateObject objects.

    Parameters

    • name string
      :

      The name of the State property being registered for.

    • fn BuilderFunction
      :

      The BuilderFunction which will be used to build the State property

    Returns Function | function | function[]

    :

    a function which deregisters the BuilderFunction

Generated using TypeDoc