Class: BatchedRequester\<ResourceType>
A singleton for handling batched requests
Type parameters
| Name | Type |
|---|---|
ResourceType |
extends SolidContainer | SolidLeaf |
Hierarchy
BatchedRequester
Constructors
constructor
• new BatchedRequester\<ResourceType>(context): BatchedRequester\<ResourceType>
Type parameters
| Name | Type |
|---|---|
ResourceType |
extends SolidContainer | SolidLeaf |
Parameters
| Name | Type | Description |
|---|---|---|
context |
ConnectedContext\<SolidConnectedPlugin[]> |
SolidLdoDatasetContext for the parent SolidLdoDataset |
Returns
BatchedRequester\<ResourceType>
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:54
Properties
context
• Protected context: ConnectedContext\<SolidConnectedPlugin[]>
ConnectedContext for the parent Dataset
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:49
requestBatcher
• Protected Readonly requestBatcher: RequestBatcher
A request batcher to maintain state for ongoing requests
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:38
resource
• Readonly Abstract resource: ResourceType
The uri of the resource
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:43
Methods
createDataResource
▸ createDataResource(overwrite): Promise\<ContainerCreateAndOverwriteResult | LeafCreateAndOverwriteResult>
Creates a Resource
Parameters
| Name | Type | Description |
|---|---|---|
overwrite |
true |
If true, this will orverwrite the resource if it already exists |
Returns
Promise\<ContainerCreateAndOverwriteResult | LeafCreateAndOverwriteResult>
A ContainerCreateAndOverwriteResult or a LeafCreateAndOverwriteResult depending on this resource's URI
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:144
▸ createDataResource(overwrite?): Promise\<ContainerCreateIfAbsentResult | LeafCreateIfAbsentResult>
Parameters
| Name | Type |
|---|---|
overwrite? |
false |
Returns
Promise\<ContainerCreateIfAbsentResult | LeafCreateIfAbsentResult>
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:147
▸ createDataResource(overwrite?): Promise\<ContainerReadSuccess | ServerHttpError\<SolidContainer> | UnexpectedHttpError\<SolidContainer> | UnauthenticatedHttpError\<SolidContainer> | UnauthorizedHttpError\<SolidContainer> | NoncompliantPodError\<SolidContainer> | UnexpectedResourceError\<SolidContainer> | CreateSuccess\<SolidContainer> | BinaryReadSuccess | ServerHttpError\<SolidLeaf> | UnexpectedHttpError\<SolidLeaf> | UnauthenticatedHttpError\<SolidLeaf> | UnauthorizedHttpError\<SolidLeaf> | UnexpectedResourceError\<SolidLeaf> | CreateSuccess\<SolidLeaf> | DataReadSuccess | NoncompliantPodError\<SolidLeaf>>
Parameters
| Name | Type |
|---|---|
overwrite? |
boolean |
Returns
Promise\<ContainerReadSuccess | ServerHttpError\<SolidContainer> | UnexpectedHttpError\<SolidContainer> | UnauthenticatedHttpError\<SolidContainer> | UnauthorizedHttpError\<SolidContainer> | NoncompliantPodError\<SolidContainer> | UnexpectedResourceError\<SolidContainer> | CreateSuccess\<SolidContainer> | BinaryReadSuccess | ServerHttpError\<SolidLeaf> | UnexpectedHttpError\<SolidLeaf> | UnauthenticatedHttpError\<SolidLeaf> | UnauthorizedHttpError\<SolidLeaf> | UnexpectedResourceError\<SolidLeaf> | CreateSuccess\<SolidLeaf> | DataReadSuccess | NoncompliantPodError\<SolidLeaf>>
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:150
delete
▸ delete(): Promise\<DeleteResult\<ResourceType>>
Delete this resource
Returns
Promise\<DeleteResult\<ResourceType>>
A DeleteResult
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:118
isCreating
▸ isCreating(): boolean
Checks if the resource is currently executing a create request
Returns
boolean
true if the resource is currently executing a create request
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:70
isDeletinng
▸ isDeletinng(): boolean
Checks if the resource is currently executing a delete request
Returns
boolean
true if the resource is currently executing a delete request
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:86
isLoading
▸ isLoading(): boolean
Checks if the resource is currently making any request
Returns
boolean
true if the resource is making any requests
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:62
isReading
▸ isReading(): boolean
Checks if the resource is currently executing a read request
Returns
boolean
true if the resource is currently executing a read request
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:78
read
▸ read(): Promise\<ReadContainerResult | ReadLeafResult>
Read this resource.
Returns
Promise\<ReadContainerResult | ReadLeafResult>
A ReadLeafResult or a ReadContainerResult depending on the uri of this resource
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:95