ui-router-registry / ui-router-registry / TypedStateService

Interface: TypedStateService

Defined in: registry.ts:414

A typed view of core's StateService. It is assignable both ways: core's class fills a typed getter or field with no cast and emits nothing, and the view passes wherever a StateService is expected.

Extends

• StateService

Methods

go()

go<T>(to, ...args): TransitionPromise;

Defined in: registry.ts:416

StateService.go, with a registered name's params required as declared.

Type Parameters

Type Parameter
T extends | string | UncheckedRef | StateDeclaration | StateObject

Parameters

Parameter	Type
to	T & CheckRelative<T>
...args	TargetArgs<T, TransitionOptions>

Returns

TransitionPromise

Overrides

StateService.go

---

href()

href<T>(stateOrName, ...args): string;

Defined in: registry.ts:434

StateService.href, typed as for go.

Type Parameters

Type Parameter
T extends | string | UncheckedRef | StateDeclaration | StateObject

Parameters

Parameter	Type
stateOrName	T & CheckRelative<T>
...args	TargetArgs<T, HrefOptions>

Returns

string

Overrides

StateService.href

---

includes()

Call Signature

includes<N>(
   stateOrName, 
   params?, 
   options?
): boolean;

Defined in: registry.ts:458

StateService.includes, over registered names, globs and their params.

Type Parameters

Type Parameter
N extends string

Parameters

Parameter	Type
stateOrName	string | N
params?	Partial<RawParams>
options?	TransitionOptions

Returns

boolean

Overrides

StateService.includes

Call Signature

includes(
   stateOrName, 
   params?, 
   options?
): boolean;

Defined in: registry.ts:464

StateService.includes for an UncheckedRef or an object target, with loose params.

Parameters

Parameter	Type
stateOrName	| UncheckedRef | StateDeclaration | StateObject
params?	RawParams
options?	TransitionOptions

Returns

boolean

Overrides

StateService.includes

---

is()

Call Signature

is<N>(
   stateOrName, 
   params?, 
   options?
): boolean;

Defined in: registry.ts:445

StateService.is, over registered names and their params.

Type Parameters

Type Parameter
N extends string

Parameters

Parameter	Type
stateOrName	N
params?	Partial<RawParams>
options?	{ relative?: | string | StateDeclaration | StateObject; }
options.relative?	| string | StateDeclaration | StateObject

Returns

boolean

Overrides

StateService.is

Call Signature

is(
   stateOrName, 
   params?, 
   options?
): boolean;

Defined in: registry.ts:451

StateService.is for an UncheckedRef or an object target, with loose params.

Parameters

Parameter	Type
stateOrName	| UncheckedRef | StateDeclaration | StateObject
params?	RawParams
options?	{ relative?: | string | StateDeclaration | StateObject; }
options.relative?	| string | StateDeclaration | StateObject

Returns

boolean

Overrides

StateService.is

---

reload()

reload(reloadState?): Promise<StateObject>;

Defined in: registry.ts:440

StateService.reload: a registered name, or an object target or UncheckedRef.

Parameters

Parameter	Type
reloadState?	| string | UncheckedRef | StateDeclaration | StateObject

Returns

Promise<StateObject>

Overrides

StateService.reload

---

target()

target<T>(identifier, ...args): TargetState;

Defined in: registry.ts:428

StateService.target, typed as for go.

Type Parameters

Type Parameter
T extends | string | UncheckedRef | StateDeclaration | StateObject

Parameters

Parameter	Type
identifier	T & CheckRelative<T>
...args	TargetArgs<T, TransitionOptions>

Returns

TargetState

Overrides

StateService.target

---

transitionTo()

transitionTo<T>(to, ...args): TransitionPromise;

Defined in: registry.ts:422

StateService.transitionTo, typed as for go.

Type Parameters

Type Parameter
T extends | string | UncheckedRef | StateDeclaration | StateObject

Parameters

Parameter	Type
to	T & CheckRelative<T>
...args	TargetArgs<T, TransitionOptions>

Returns

TransitionPromise

Overrides

StateService.transitionTo