Skip to content

Commit 4b92872

Browse files
refactor(urlservice): rename api interfaces to *Api
1 parent 8c2461d commit 4b92872

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

src/params/interface.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ export interface Replace {
408408
* $state.go('list', { item: "Ringo" });
409409
* ```
410410
*
411-
* See: [[UrlConfig.type]]
411+
* See: [[UrlConfigApi.type]]
412412
* @coreapi
413413
*/
414414
export interface ParamTypeDefinition {

src/url/interface.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export interface ParamFactory {
4141
*
4242
* This API is found on [[UrlService.config]].
4343
*/
44-
export interface UrlConfig extends LocationConfig, UrlMatcherConfig {}
44+
export interface UrlConfigApi extends LocationConfig, UrlMatcherConfig {}
4545

4646
export interface UrlMatcherConfig {
4747
/**
@@ -199,7 +199,7 @@ export interface UrlSyncApi {
199199
*
200200
* The most commonly used methods are [[otherwise]] and [[when]].
201201
*/
202-
export interface UrlRules {
202+
export interface UrlRulesApi {
203203
/**
204204
* Defines URL Rule priorities
205205
*
@@ -414,7 +414,7 @@ export type UrlRuleType = "STATE" | "URLMATCHER" | "REGEXP" | "RAW" | "OTHER";
414414
/**
415415
* The interface for a URL Rule
416416
*
417-
* If you are creating a rule for use with [[UrlRules.rule]], it should implement this interface.
417+
* If you are creating a rule for use with [[UrlRulesApi.rule]], it should implement this interface.
418418
*/
419419
export interface UrlRule {
420420
/**

src/url/urlRouter.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { UIRouter } from "../router";
1212
import { val, is, pattern, prop, pipe } from "../common/hof";
1313
import { UrlRuleFactory } from "./urlRule";
1414
import { TargetState } from "../state/targetState";
15-
import { UrlRule, UrlRuleHandlerFn, UrlParts, UrlRules, UrlSyncApi, MatchResult } from "./interface";
15+
import { UrlRule, UrlRuleHandlerFn, UrlParts, UrlRulesApi, UrlSyncApi, MatchResult } from "./interface";
1616
import { TargetStateDef } from "../state/interface";
1717

1818
/** @hidden */
@@ -54,7 +54,7 @@ defaultRuleSortFn = composeSort(
5454
* This class updates the URL when the state changes.
5555
* It also responds to changes in the URL.
5656
*/
57-
export class UrlRouter implements UrlRules, UrlSyncApi, Disposable {
57+
export class UrlRouter implements UrlRulesApi, UrlSyncApi, Disposable {
5858
/** used to create [[UrlRule]] objects for common cases */
5959
public urlRuleFactory: UrlRuleFactory;
6060

src/url/urlService.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import { UIRouter } from "../router";
77
import { LocationServices, notImplemented, LocationConfig } from "../common/coreservices";
88
import { noop, createProxyFunctions } from "../common/common";
9-
import { UrlConfig, UrlSyncApi, UrlRules, UrlParts, MatchResult } from "./interface";
9+
import { UrlConfigApi, UrlSyncApi, UrlRulesApi, UrlParts, MatchResult } from "./interface";
1010

1111
/** @hidden */
1212
const makeStub = (keys: string[]): any =>
@@ -67,16 +67,16 @@ export class UrlService implements LocationServices, UrlSyncApi {
6767
/**
6868
* A nested API for managing URL rules and rewrites
6969
*
70-
* See: [[UrlRules]] for details
70+
* See: [[UrlRulesApi]] for details
7171
*/
72-
rules: UrlRules;
72+
rules: UrlRulesApi;
7373

7474
/**
7575
* A nested API to configure the URL and retrieve URL information
7676
*
77-
* See: [[UrlConfig]] for details
77+
* See: [[UrlConfigApi]] for details
7878
*/
79-
config: UrlConfig;
79+
config: UrlConfigApi;
8080

8181
/** @hidden */
8282
private router: UIRouter;

0 commit comments

Comments
 (0)