@hulanbv/nest-utilities-client-state
Advanced tools
Comparing version 0.0.3 to 0.0.4
{ | ||
"name": "@hulanbv/nest-utilities-client-state", | ||
"version": "0.0.3", | ||
"version": "0.0.4", | ||
"description": "React hooks for state management when using nest-utilities-client and a nest-utilities based API.", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -19,3 +19,3 @@ # nest-utilities-client-state | ||
<p> | ||
This package provides a simpler way to manage data from a server (that utilizes [nest-utilities](https://www.npmjs.com/package/nest-utilities)), for apps that use [nest-utilities-client](https://www.npmjs.com/package/nest-utilities-client). | ||
This package provides a simpler way to manage data from a server (that utilizes <a href="https://www.npmjs.com/package/nest-utilities">nest-utilities</a>), for apps that use <a href="https://www.npmjs.com/package/nest-utilities-client">nest-utilities-client</a>. | ||
</p> | ||
@@ -40,5 +40,5 @@ <p> | ||
Or, for edge cases: [`useRequest`](#useRequestservice-query-method-httpOptions-stateOptions). | ||
Or, for edge cases: <a href="#useRequestservice-query-method-httpOptions-stateOptions">`useRequest`</a>. | ||
All these hooks return an [IRequestState](#interface-IRequestState) object. The following example implements request state properties in a practical context. | ||
All these hooks return an <a href="#interface-IRequestState">IRequestState</a> object. The following example implements request state properties in a practical context. | ||
@@ -233,11 +233,11 @@ #### Simple implementation | ||
`service`: [CrudService](https://www.npmjs.com/package/nest-utilities-client) | ||
`service`: <a href="https://www.npmjs.com/package/nest-utilities-client">CrudService</a> | ||
`httpOptions?`: [IHttpOptions](https://www.npmjs.com/package/nest-utilities-client) | ||
`httpOptions?`: <a href="https://www.npmjs.com/package/nest-utilities-client">IHttpOptions</a> | ||
`stateOptions?`: [IStateOptions](#interface-IStateOptions) | ||
`stateOptions?`: <a href="#interface-IStateOptions">IStateOptions</a> | ||
**Returns** | ||
[IRequestState](#interface-IRequestState) | ||
<a href="#interface-IRequestState">IRequestState</a> | ||
@@ -256,13 +256,13 @@ **Example** | ||
`service`: [CrudService](https://www.npmjs.com/package/nest-utilities-client) | ||
`service`: <a href="https://www.npmjs.com/package/nest-utilities-client">CrudService</a> | ||
`id?`: string | ||
`httpOptions?`: [IHttpOptions](https://www.npmjs.com/package/nest-utilities-client) | ||
`httpOptions?`: <a href="https://www.npmjs.com/package/nest-utilities-client">IHttpOptions</a> | ||
`stateOptions?`: [IStateOptions](#interface-IStateOptions) | ||
`stateOptions?`: <a href="#interface-IStateOptions">IStateOptions</a> | ||
**Returns** | ||
[IRequestState](#interface-IRequestState) | ||
<a href="#interface-IRequestState">IRequestState</a> | ||
@@ -283,13 +283,13 @@ **Example** | ||
`service`: [CrudService](https://www.npmjs.com/package/nest-utilities-client) | ||
`service`: <a href="https://www.npmjs.com/package/nest-utilities-client">CrudService</a> | ||
`id?`: string | ||
`httpOptions?`: [IHttpOptions](https://www.npmjs.com/package/nest-utilities-client) | ||
`httpOptions?`: <a href="https://www.npmjs.com/package/nest-utilities-client">IHttpOptions</a> | ||
`stateOptions?`: [IStateOptions](#interface-IStateOptions) | ||
`stateOptions?`: <a href="#interface-IStateOptions">IStateOptions</a> | ||
**Returns** | ||
[IRequestState](#interface-IRequestState) | ||
<a href="#interface-IRequestState">IRequestState</a> | ||
@@ -313,13 +313,13 @@ **Example** | ||
`service`: [CrudService](https://www.npmjs.com/package/nest-utilities-client) | ||
`service`: <a href="https://www.npmjs.com/package/nest-utilities-client">CrudService</a> | ||
`ids`: Array\<string> | ||
`httpOptions?`: [IHttpOptions](https://www.npmjs.com/package/nest-utilities-client) | ||
`httpOptions?`: <a href="https://www.npmjs.com/package/nest-utilities-client">IHttpOptions</a> | ||
`stateOptions?`: [IStateOptions](#interface-IStateOptions) | ||
`stateOptions?`: <a href="#interface-IStateOptions">IStateOptions</a> | ||
**Returns** | ||
[IRequestState](#interface-IRequestState) | ||
<a href="#interface-IRequestState">IRequestState</a> | ||
@@ -340,13 +340,13 @@ **Example** | ||
`service`: [CrudService](https://www.npmjs.com/package/nest-utilities-client) | ||
`service`: <a href="https://www.npmjs.com/package/nest-utilities-client">CrudService</a> | ||
`id?`: string | ||
`httpOptions?`: [IHttpOptions](https://www.npmjs.com/package/nest-utilities-client) | ||
`httpOptions?`: <a href="https://www.npmjs.com/package/nest-utilities-client">IHttpOptions</a> | ||
`stateOptions?`: [IStateOptions](#interface-IStateOptions) | ||
`stateOptions?`: <a href="#interface-IStateOptions">IStateOptions</a> | ||
**Returns** | ||
[IRequestState](#interface-IRequestState) | ||
<a href="#interface-IRequestState">IRequestState</a> | ||
@@ -372,11 +372,11 @@ **Example** | ||
`service`: [CrudService](https://www.npmjs.com/package/nest-utilities-client) | ||
`service`: <a href="https://www.npmjs.com/package/nest-utilities-client">CrudService</a> | ||
`httpOptions?`: [IHttpOptions](https://www.npmjs.com/package/nest-utilities-client) | ||
`httpOptions?`: <a href="https://www.npmjs.com/package/nest-utilities-client">IHttpOptions</a> | ||
`stateOptions?`: [IStateOptions](#interface-IStateOptions) | ||
`stateOptions?`: <a href="#interface-IStateOptions">IStateOptions</a> | ||
**Returns** | ||
[IRequestState](#interface-IRequestState) | ||
<a href="#interface-IRequestState">IRequestState</a> | ||
@@ -404,13 +404,13 @@ **Example** | ||
`service`: [CrudService](https://www.npmjs.com/package/nest-utilities-client) | ||
`service`: <a href="https://www.npmjs.com/package/nest-utilities-client">CrudService</a> | ||
`id?`: string | ||
`httpOptions?`: [IHttpOptions](https://www.npmjs.com/package/nest-utilities-client) | ||
`httpOptions?`: <a href="https://www.npmjs.com/package/nest-utilities-client">IHttpOptions</a> | ||
`stateOptions?`: [IStateOptions](#interface-IStateOptions) | ||
`stateOptions?`: <a href="#interface-IStateOptions">IStateOptions</a> | ||
**Returns** | ||
[IRequestState](#interface-IRequestState) | ||
<a href="#interface-IRequestState">IRequestState</a> | ||
@@ -436,3 +436,3 @@ **Example** | ||
`service`: [CrudService](https://www.npmjs.com/package/nest-utilities-client) | ||
`service`: <a href="https://www.npmjs.com/package/nest-utilities-client">CrudService</a> | ||
@@ -443,9 +443,9 @@ `query?`: string | ||
`httpOptions?`: [IHttpOptions](https://www.npmjs.com/package/nest-utilities-client) | ||
`httpOptions?`: <a href="https://www.npmjs.com/package/nest-utilities-client">IHttpOptions</a> | ||
`stateOptions?`: [IStateOptions](#interface-IStateOptions) | ||
`stateOptions?`: <a href="#interface-IStateOptions">IStateOptions</a> | ||
**Returns** | ||
[IRequestState](#interface-IRequestState) | ||
<a href="#interface-IRequestState">IRequestState</a> | ||
@@ -471,10 +471,10 @@ **Example** | ||
| Property | Type | | ||
| ---------- | --------------------------------------------------------------------- | | ||
| cacheKey | \<optional> string | | ||
| data | \<response data> \| null | | ||
| fetchState | [FetchState](#enum-FetchState) | | ||
| response | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | | ||
| service | [CrudService](https://www.npmjs.com/package/nest-utilities-client) | | ||
| call | [IStateUpdater](#function-IStateUpdater) | | ||
| Property | Type | | ||
| ---------- | -------------------------------------------------------------------------------- | | ||
| cacheKey | \<optional> string | | ||
| data | \<response data> \| null | | ||
| fetchState | <a href="#enum-FetchState">FetchState</a> | | ||
| response | <a href="https://developer.mozilla.org/en-US/docs/Web/API/Response">Response</a> | | ||
| service | <a href="https://www.npmjs.com/package/nest-utilities-client">CrudService</a> | | ||
| call | <a href="#function-IStateUpdater">IStateUpdater</a> | | ||
@@ -481,0 +481,0 @@ ### `interface IStateOptions` |
71929