Skip to content

Commit a7b58d6

Browse files
docs(UrlService): Document url service API
fix(UrlService): Wire urlMatcherFactory and urlRouter functions
1 parent eb2f5d7 commit a7b58d6

File tree

9 files changed

+459
-318
lines changed

9 files changed

+459
-318
lines changed

src/common/coreservices.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,9 @@ export interface LocationConfig extends Disposable {
169169
hashPrefix(newprefix: string): string;
170170
}
171171

172+
/** @hidden */
172173
export interface TemplateServices {
173174
get(url: string): Promise<string>;
174175
}
175176

176-
177177
export {services};

src/params/interface.ts

+8-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* @coreapi
33
* @module params
44
*/ /** for typedoc */
5+
56
import {ParamType} from "./type";
67

78
/**
@@ -16,11 +17,14 @@ import {ParamType} from "./type";
1617
* folderId: 'inbox'
1718
* }
1819
* ```
20+
*
21+
* @coreapi
1922
*/
2023
export interface RawParams {
2124
[key: string]: any;
2225
}
2326

27+
/** @internalapi */
2428
export type ParamsOrArray = (RawParams|RawParams[]);
2529

2630
/**
@@ -53,6 +57,7 @@ export type ParamsOrArray = (RawParams|RawParams[]);
5357
* }
5458
* }
5559
* ```
60+
* @coreapi
5661
*/
5762
export interface ParamDeclaration {
5863
/**
@@ -291,6 +296,7 @@ export interface ParamDeclaration {
291296
raw: boolean;
292297
}
293298

299+
/** @internalapi */
294300
export interface Replace {
295301
from: string;
296302
to: string;
@@ -402,7 +408,8 @@ export interface Replace {
402408
* $state.go('list', { item: "Ringo" });
403409
* ```
404410
*
405-
* See: [[UrlMatcherFactory.type]]
411+
* See: [[UrlConfig.type]]
412+
* @coreapi
406413
*/
407414
export interface ParamTypeDefinition {
408415
/**

src/url/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ export * from "./urlMatcher";
77
export * from "./urlMatcherFactory";
88
export * from "./urlRouter";
99
export * from "./urlRule";
10+
export * from "./urlService";

0 commit comments

Comments
 (0)