Class: ContainerBatchedRequester
A singleton to handle batched requests for containers
Hierarchy
↳ ContainerBatchedRequester
Constructors
constructor
• new ContainerBatchedRequester(resource, context): ContainerBatchedRequester
Parameters
| Name | Type | Description |
|---|---|---|
resource |
SolidContainer |
- |
context |
ConnectedContext\<SolidConnectedPlugin[]> |
ConnectedContext of the parent dataset |
Returns
Overrides
Defined in
packages/connected-solid/src/requester/ContainerBatchedRequester.ts:31
Properties
context
• Protected context: ConnectedContext\<SolidConnectedPlugin[]>
ConnectedContext for the parent Dataset
Inherited from
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:49
requestBatcher
• Protected Readonly requestBatcher: RequestBatcher
A request batcher to maintain state for ongoing requests
Inherited from
BatchedRequester.requestBatcher
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:38
resource
• Readonly resource: SolidContainer
The URI of the container
Overrides
Defined in
packages/connected-solid/src/requester/ContainerBatchedRequester.ts:25
Methods
createDataResource
▸ createDataResource(overwrite): Promise\<ContainerCreateAndOverwriteResult>
Creates the container
Parameters
| Name | Type | Description |
|---|---|---|
overwrite |
true |
If true, this will orverwrite the resource if it already exists |
Returns
Promise\<ContainerCreateAndOverwriteResult>
Overrides
BatchedRequester.createDataResource
Defined in
packages/connected-solid/src/requester/ContainerBatchedRequester.ts:52
▸ createDataResource(overwrite?): Promise\<ContainerCreateIfAbsentResult>
Parameters
| Name | Type |
|---|---|
overwrite? |
false |
Returns
Promise\<ContainerCreateIfAbsentResult>
Overrides
BatchedRequester.createDataResource
Defined in
packages/connected-solid/src/requester/ContainerBatchedRequester.ts:55
▸ createDataResource(overwrite?): Promise\<ContainerReadSuccess | ServerHttpError\<SolidContainer> | UnexpectedHttpError\<SolidContainer> | UnauthenticatedHttpError\<SolidContainer> | UnauthorizedHttpError\<SolidContainer> | NoncompliantPodError\<SolidContainer> | UnexpectedResourceError\<SolidContainer> | CreateSuccess\<SolidContainer>>
Parameters
| Name | Type |
|---|---|
overwrite? |
boolean |
Returns
Promise\<ContainerReadSuccess | ServerHttpError\<SolidContainer> | UnexpectedHttpError\<SolidContainer> | UnauthenticatedHttpError\<SolidContainer> | UnauthorizedHttpError\<SolidContainer> | NoncompliantPodError\<SolidContainer> | UnexpectedResourceError\<SolidContainer> | CreateSuccess\<SolidContainer>>
Overrides
BatchedRequester.createDataResource
Defined in
packages/connected-solid/src/requester/ContainerBatchedRequester.ts:56
delete
▸ delete(): Promise\<DeleteResult\<SolidContainer>>
Delete this resource
Returns
Promise\<DeleteResult\<SolidContainer>>
A DeleteResult
Inherited from
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
Inherited from
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
Inherited from
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
Inherited from
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
Inherited from
Defined in
packages/connected-solid/src/requester/BatchedRequester.ts:78
isRootContainer
▸ isRootContainer(): Promise\<CheckRootResult>
Checks to see if this container is a root container
Returns
Promise\<CheckRootResult>
A CheckRootResult
Defined in
packages/connected-solid/src/requester/ContainerBatchedRequester.ts:73
read
▸ read(): Promise\<ReadContainerResult>
Reads the container
Returns
Promise\<ReadContainerResult>
A ReadContainerResult
Overrides
Defined in
packages/connected-solid/src/requester/ContainerBatchedRequester.ts:43