@empathyco/x-components 7.3.1 → 7.4.1

package/docs/API-reference/api/x-components.increasebrowsepageappendingresultswire.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [increaseBrowsePageAppendingResultsWire](./x-components.increasebrowsepageappendingresultswire.md)
+
+## increaseBrowsePageAppendingResultsWire variable
+
+Increases the current browse state `page` by one.
+
+**Signature:**
+
+```typescript
+increaseBrowsePageAppendingResultsWire: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.internalbrowserequest.md

@@ -0,0 +1,59 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [InternalBrowseRequest](./x-components.internalbrowserequest.md)
+
+## InternalBrowseRequest interface
+
+An internal browse request containing the page used to calculate the start and rows properties of a [BrowseRequest](./x-types.browserequest.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface InternalBrowseRequest extends BrowseRequest 
+```
+**Extends:** BrowseRequest
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[page](./x-components.internalbrowserequest.page.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The page number.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.internalbrowserequest.page.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [InternalBrowseRequest](./x-components.internalbrowserequest.md) &gt; [page](./x-components.internalbrowserequest.page.md)
+
+## InternalBrowseRequest.page property
+
+The page number.
+
+**Signature:**
+
+```typescript
+page: number;
+```

package/docs/API-reference/api/x-components.internalbrowseresponse.md

@@ -0,0 +1,78 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [InternalBrowseResponse](./x-components.internalbrowseresponse.md)
+
+## InternalBrowseResponse interface
+
+An internal browse response containing the [InternalBrowseRequest](./x-components.internalbrowserequest.md) performed to get a [BrowseResponse](./x-types.browseresponse.md) and its [RequestStatus](./x-components.requeststatus.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface InternalBrowseResponse extends BrowseResponse 
+```
+**Extends:** BrowseResponse
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[request](./x-components.internalbrowseresponse.request.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[InternalBrowseRequest](./x-components.internalbrowserequest.md)
+
+
+</td><td>
+
+The browse request.
+
+
+</td></tr>
+<tr><td>
+
+[status](./x-components.internalbrowseresponse.status.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RequestStatus](./x-components.requeststatus.md)
+
+
+</td><td>
+
+The response status.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.internalbrowseresponse.request.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [InternalBrowseResponse](./x-components.internalbrowseresponse.md) &gt; [request](./x-components.internalbrowseresponse.request.md)
+
+## InternalBrowseResponse.request property
+
+The browse request.
+
+**Signature:**
+
+```typescript
+request: InternalBrowseRequest;
+```

package/docs/API-reference/api/x-components.internalbrowseresponse.status.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [InternalBrowseResponse](./x-components.internalbrowseresponse.md) &gt; [status](./x-components.internalbrowseresponse.status.md)
+
+## InternalBrowseResponse.status property
+
+The response status.
+
+**Signature:**
+
+```typescript
+status: RequestStatus;
+```