Skip to content

Commit ff2400f

Browse files
maurobendermaurobender
committed
Fix links to types in docs
1 parent 2104c11 commit ff2400f

File tree

2 files changed

+28
-28
lines changed

2 files changed

+28
-28
lines changed

‎docs/classes/api_entity_service.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ constructor( { api, basePath, parser, creator, errorParser, paths } ): ApiEntity
2424

2525
| Name | Type | Description | Required | Default |
2626
| ---- | ---- | ------ | ------ | ---- |
27-
| api | [IApi](../types#iapi) | The api client to use to connect with the remote API | yes | - |
27+
| api | [IApi](../types.md#iapi) | The api client to use to connect with the remote API | yes | - |
2828
| basePath | `string` | The base path for the resource without the leading and ending slash. | yes | - |
29-
| parser | [IResponseParser](../types#iresponseparser) | An object in charge of parsing the API responses | yes | - |
30-
| creator | [IEntityCreator](../types#ientitycreator) | An object in charge of creating the fetched entities in the correct stores | yes | - |
31-
| errorParser | [IErrorParser](../types#ierrorparser) | An object in charge of parsing the error responses | no |`NullErrorParser` |
32-
| paths | [ICustomPaths](../types#icustompaths) | A hash indicating custom paths for the CRUD methods | no | `{}` |
29+
| parser | [IResponseParser](../types.md#iresponseparser) | An object in charge of parsing the API responses | yes | - |
30+
| creator | [IEntityCreator](../types.md#ientitycreator) | An object in charge of creating the fetched entities in the correct stores | yes | - |
31+
| errorParser | [IErrorParser](../types.md#ierrorparser) | An object in charge of parsing the error responses | no |`NullErrorParser` |
32+
| paths | [ICustomPaths](../types.md#icustompaths) | A hash indicating custom paths for the CRUD methods | no | `{}` |
3333

3434
#### Return
3535

@@ -51,13 +51,13 @@ create( attributes, params, config ): Promise<SingleEntityResponse<T>>
5151

5252
| Name | Type | Description | Required | Default |
5353
| ---- | ---- | ------ | ------ | ---- |
54-
| attributes | [Attributes](../types#attributes) | The attributes for the new entity to create | yes | - |
55-
| params | [Params](../types#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
56-
| config | [RequestWithBodyConfig](../types#requestwithbodyconfig) | Additional configuration for the request to the remote API | no | `{}` |
54+
| attributes | [Attributes](../types.md#attributes) | The attributes for the new entity to create | yes | - |
55+
| params | [Params](../types.md#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
56+
| config | [RequestWithBodyConfig](../types.md#requestwithbodyconfig) | Additional configuration for the request to the remote API | no | `{}` |
5757

5858
#### Return
5959

60-
Returns a promise that resolves to a [response object](../types#singleentityresponse) containing the created entity if the request to the API is successful.
60+
Returns a promise that resolves to a [response object](../types.md#singleentityresponse) containing the created entity if the request to the API is successful.
6161

6262
### update
6363

@@ -71,14 +71,14 @@ update( id, attributes, params, config ): Promise<SingleEntityResponse<T>>
7171

7272
| Name | Type | Description | Required | Default |
7373
| ---- | ---- | ------ | ------ | ---- |
74-
| id | [EntityID](../types#entityid) | The ID of the entity to update | yes | - |
75-
| attributes | [Attributes](../types#attributes) | The attributes to update | yes | - |
76-
| params | [Params](../types#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
77-
| config | [RequestWithBodyConfig](../types#requestwithbodyconfig) | Additional configuration for the request to the remote API | no | `{}` |
74+
| id | [EntityID](../types.md#entityid) | The ID of the entity to update | yes | - |
75+
| attributes | [Attributes](../types.md#attributes) | The attributes to update | yes | - |
76+
| params | [Params](../types.md#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
77+
| config | [RequestWithBodyConfig](../types.md#requestwithbodyconfig) | Additional configuration for the request to the remote API | no | `{}` |
7878

7979
#### Return
8080

81-
Returns a promise that resolves to a [response object](../types#singleentityresponse) containing the update entity if the request to the API is successful.
81+
Returns a promise that resolves to a [response object](../types.md#singleentityresponse) containing the update entity if the request to the API is successful.
8282

8383
### fetch
8484

@@ -92,12 +92,12 @@ fetch( id, params ): Promise<SingleEntityResponse<T>>
9292

9393
| Name | Type | Description | Required | Default |
9494
| ---- | ---- | ------ | ------ | ---- |
95-
| id | [EntityID](../types#entity-id) | The ID of the entity to fetch | yes | - |
96-
| params | [Params](../types#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
95+
| id | [EntityID](../types.md#entity-id) | The ID of the entity to fetch | yes | - |
96+
| params | [Params](../types.md#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
9797

9898
#### Return
9999

100-
Returns a promise that resolves to a [response object](../types#singleentityresponse) containing the fetched entity if the request to the API is successful.
100+
Returns a promise that resolves to a [response object](../types.md#singleentityresponse) containing the fetched entity if the request to the API is successful.
101101

102102
### fetchAll
103103

@@ -111,11 +111,11 @@ fetchAll( params ): Promise<MultiEntityResponse<T>>
111111

112112
| Name | Type | Description | Required | Default |
113113
| ---- | ---- | ------ | ------ | ---- |
114-
| params | [Params](../types#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
114+
| params | [Params](../types.md#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
115115

116116
#### Return
117117

118-
Returns a promise that resolves to a [response object](../types#multientityresponse) containing the fetched entities if the request to the API is successful.
118+
Returns a promise that resolves to a [response object](../types.md#multientityresponse) containing the fetched entities if the request to the API is successful.
119119

120120
### delete
121121

@@ -129,8 +129,8 @@ delete( id, params ): Promise<SingleEntityResponse<T>>
129129

130130
| Name | Type | Description | Required | Default |
131131
| ---- | ---- | ------ | ------ | ---- |
132-
| id | [EntityID](../types#entityid) | The ID of the entity to delete | yes | - |
133-
| params | [Params](../types#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
132+
| id | [EntityID](../types.md#entityid) | The ID of the entity to delete | yes | - |
133+
| params | [Params](../types.md#params) | Additional query parameters to send with the request to the remote API | no | `{}` |
134134

135135
#### Return
136136

@@ -147,12 +147,12 @@ request( { method, url, attributes, params, config } ): Promise<EntityResponse<T
147147

148148
| Name | Type | Description | Required | Default |
149149
| ---- | ---- | ------ | ------ | ---- |
150-
| method | [HTTPMethod](../types#httpmethod) | The HTTP method to use in the request. | no | `HTTPMethod.GET` |
150+
| method | [HTTPMethod](../types.md#httpmethod) | The HTTP method to use in the request. | no | `HTTPMethod.GET` |
151151
| url | `string` | The api path to call. Note that this method does not use the base path to make the request so if you want a URL relative to the base path you have to do it yourself and pass it here. | no | `HTTPMethod.GET` |
152-
| attributes | [Attributes](../types#attributes) | Attributes to send as the body of the request. | no | `null` |
153-
| params | [Params](../types#params) | Query parameters to send with the request to the remote API. | no | `{}` |
154-
| config | [RequestWithBodyConfig](../types#requestwithbodyconfig) | Additional configuration for the request to the remote API. | no | `{}` |
152+
| attributes | [Attributes](../types.md#attributes) | Attributes to send as the body of the request. | no | `null` |
153+
| params | [Params](../types.md#params) | Query parameters to send with the request to the remote API. | no | `{}` |
154+
| config | [RequestWithBodyConfig](../types.md#requestwithbodyconfig) | Additional configuration for the request to the remote API. | no | `{}` |
155155

156156
#### Return
157157

158-
Returns a promise that resolves to a [response object](../types#multientityresponse) containing the fetched entities if the request to the API is successful.
158+
Returns a promise that resolves to a [response object](../types.md#multientityresponse) containing the fetched entities if the request to the API is successful.

‎docs/classes/entity_creator.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `EntityCreator` `constructor` receives an hash parameter with the following
1616

1717
| Name | Type | Description | Required | Default |
1818
| ---- | ---- | ------ | ------ | ---- |
19-
| rootStore | [IRootStpre](#irootstore) | The root store containing the entity stores where the entities are going to be created. | yes | - |
19+
| rootStore | [IRootStpre](../types.md#irootstore) | The root store containing the entity stores where the entities are going to be created. | yes | - |
2020

2121
##### Return
2222

@@ -43,7 +43,7 @@ create<T>( parsedResponse ): ( T | null | T[] )
4343

4444
| Name | Type | Description | Required | Default |
4545
| ---- | ---- | ------ | ------ | ---- |
46-
| parsedResponse | [ParsedResponse](#parsedresponse) | The parsed response returned by the parser. | yes | - |
46+
| parsedResponse | [ParsedResponse](../types.md#parsedresponse) | The parsed response returned by the parser. | yes | - |
4747

4848
##### Return
4949

0 commit comments

Comments
 (0)