Skip to content

Commit 459c519

Browse files
authored
docs: update API overview (#293)
# Documentation - Update API overview in readme
1 parent 74a25f5 commit 459c519

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,18 @@ Published with partial Ivy compilation.
1919

2020
A `RouterStore` service has the following public properties:
2121

22-
| API | Description |
23-
| ------------------------------------------------------------------ | ------------------------------------------ |
24-
| `currentRoute$: Observable<MinimalActivatedRouteSnapshot>` | Select the current route. |
25-
| `fragment$: Observable<string \| null>` | Select the current route fragment. |
26-
| `queryParams$: Observable<Params>` | Select the current route query parameters. |
27-
| `routeData$: Observable<Data>` | Select the current route data. |
28-
| `routeParams$: Observable<Params>` | Select the current route parameters. |
29-
| `url$: Observable<string>` | Select the current URL. |
30-
| `selectQueryParam(param: string): Observable<string \| undefined>` | Select the specified query parameter. |
31-
| `selectRouteParam(param: string): Observable<string \| undefined>` | Select the specified route parameter. |
22+
| API | Description |
23+
| ----------------------------------------------------------------------- | ------------------------------------------ |
24+
| `currentRoute$: Observable<MinimalActivatedRouteSnapshot>` | Select the current route. |
25+
| `fragment$: Observable<string \| null>` | Select the current route fragment. |
26+
| `queryParams$: Observable<Params>` | Select the current route query parameters. |
27+
| `routeData$: Observable<Data>` | Select the current route data. |
28+
| `routeParams$: Observable<Params>` | Select the current route parameters. |
29+
| `title$: Observable<string \| undefined>` | Select the resolved route title. |
30+
| `url$: Observable<string>` | Select the current URL. |
31+
| `selectQueryParam(param: string): Observable<string \| undefined>` | Select the specified query parameter. |
32+
| `selectRouteData<TValue>(key: string): Observable<TValue \| undefined>` | Select the specified route data. |
33+
| `selectRouteParam(param: string): Observable<string \| undefined>` | Select the specified route parameter. |
3234

3335
A `RouterStore` service is provided by using either `provideGlobalRouterStore` or `provideLocalRouterStore`.
3436

0 commit comments

Comments
 (0)