The type of entity the endpoint represents.
Creates a new polling endpoint.
The type of entity the endpoint represents.
The endpoint used to navigate to this one.
The URI of this endpoint relative to the referrer's. Add a ./ prefix here to imply a trailing slash in the referrer's URI.
OptionalendCondition: (entity: TEntity) => boolean
A check to determine whether the entity has reached its final state and no further polling is required.
ReadonlyerrorHandles errors in responses.
ReadonlyhttpThe HTTP client used to communicate with the remote resource.
ReadonlylinkExtracts links from responses.
The interval in milliseconds to wait between polling requests. Automatically updated whenever the server sends a http!HttpHeader.RetryAfter header.
OptionalresponseA cached copy of the last response.
ReadonlyserializerControls the serialization of entities sent to and received from the server.
ReadonlyuriThe HTTP URI of the remote resource.
Shows whether the server has indicated that delete is currently allowed. Uses cached data from last response.
true if the method is allowed, false if the method is not allowed, undefined if no request has been sent yet or the server did not specify allowed methods.
Shows whether the server has indicated that merge is currently allowed. Uses cached data from last response.
true if the method is allowed, false if the method is not allowed, undefined if no request has been sent yet or the server did not specify allowed methods.
A cached copy of the entity as received from the server.
Shows whether the server has indicated that set is currently allowed. Uses cached data from last response.
true if the method is allowed, false if the method is not allowed, undefined if no request has been sent yet or the server did not specify allowed methods.
Deletes the element.
Optionalsignal: AbortSignal
Used to cancel the request.
errors!ConcurrencyError: The entity has changed since it was last retrieved with read. Your changes were rejected to prevent a lost update.
errors!HttpError: Other non-success status code
ProtecteddeletePerforms an http!HttpMethod.Delete request on the uri. Sets http!HttpHeader.IfMatch if there is a cached http!HttpHeader.ETag to detect lost updates.
Optionalsignal: AbortSignal
Used to cancel the request.
errors!ConcurrencyError: The entity has changed since it was last retrieved with getContent. Your changes were rejected to prevent a lost update.
errors!HttpError: Other non-success status code
Determines whether the element currently exists.
Optionalsignal: AbortSignal
Used to cancel the request.
errors!HttpError: Other non-success status code
ProtectedgetPerforms an http!HttpMethod.Put request on the uri and caches the response if the server sends an http!HttpHeader.ETag.
Optionalsignal: AbortSignal
Used to cancel the request.
errors!HttpError: Other non-success status code
Resolves all links with a specific relation type. Uses cached data from last response.
The relation type of the links to look for.
Retrieves a link template with a specific relation type. Uses cached data from last response. Prefer linkTemplate when possible.
The relation type of the link template to look for.
errors!NotFoundError: No link template with the specified rel could be found.
ProtectedhandleProtectedhandleHandles allowed HTTP methods and other capabilities reported by the server.
ProtectedisShows whether the server has indicated that a specific HTTP method is currently allowed. Uses cached data from last response.
The HTTP methods (e.g. GET, POST, ...) to check.
true if the method is allowed, false if the method is not allowed, undefined if no request has been sent yet or the server did not specify allowed methods.
ProtectedjoinResolves a relative URI using this endpoint's URI as the base.
The relative URI to resolve. Prepend ./ to imply a trailing slash in the base URI even if it is missing there.
Resolves a single link with a specific relation type. Uses cached data from last response.
The relation type of the link to look for.
errors!NotFoundError: No link with the specified rel could be found.
Resolves a link template with a specific relation type. Uses cached data from last response.
The relation type of the link template to look for.
Variables for resolving the template.
errors!NotFoundError: No link template with the specified rel could be found.
Modifies an existing TEntity by merging changes on the server-side.
The TEntity data to merge with the existing element.
Optionalsignal: AbortSignal
Used to cancel the request.
The TEntity as returned by the server, possibly with additional fields set. undefined if the server does not respond with a result entity.
errors!ConcurrencyError: The entity has changed since it was last retrieved with read. Your changes were rejected to prevent a lost update.
errors!HttpError: Other non-success status code
ProtectedputPerforms an http!HttpMethod.Put request on the uri. Sets http!HttpHeader.IfMatch if there is a cached http!HttpHeader.ETag to detect lost updates.
Optionalsignal: AbortSignal
Used to cancel the request.
errors!ConcurrencyError: The entity has changed since it was last retrieved with getContent. Your changes were rejected to prevent a lost update.
errors!HttpError: Other non-success status code
Returns the TEntity.
Optionalsignal: AbortSignal
Used to cancel the request.
errors!HttpError: Other non-success status code
ProtectedsendSends an HTTP request to this endpoint's URI. Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors.
The HTTP method to use.
Optionalsignal: AbortSignal
Used to cancel the request.
Optionalheaders: HeadersInit
The HTTP headers to set.
Optionalbody: BodyInit
The body to send.
Sets/replaces the TEntity.
The new TEntity.
Optionalsignal: AbortSignal
Used to cancel the request.
The TEntity as returned by the server, possibly with additional fields set. undefined if the server does not respond with a result entity.
errors!ConcurrencyError: The entity has changed since it was last retrieved with read. Your changes were rejected to prevent a lost update.
errors!HttpError: Other non-success status code
Registers one or more default links for a specific relation type. These links are used when no links with this relation type are provided by the server. This should only be called during initial setup of the endpoint.
The relation type of the link to add.
Optionalhref: string
The href of the link relative to this endpoint's URI. Leave unspecified to remove any previous entries for the relation type.
Registers a default link template for a specific relation type. This template is used when no template with this relation type is provided by the server. This should only be called during initial setup of the endpoint.
The relation type of the link to add.
Optionalhref: string
The templates href relative to this endpoint's URI. Leave unspecified to remove any previous entries for the relation type.
Provides a stream of the TEntity's states, polling the server for changes.
States that are identical to the previously provided one are skipped.
Optionalsignal: AbortSignal
Used to stop polling.
errors!HttpError: Other non-success status code
Reads the current state of the entity, applies a change to it and stores the result. Applies optimistic concurrency using automatic retries.
A callback that takes the current state of the entity and applies the desired modifications.
The maximum number of retries to perform for optimistic concurrency before giving up.
Optionalsignal: AbortSignal
Used to cancel the request.
The TEntity as returned by the server, possibly with additional fields set. undefined if the server does not respond with a result entity.
errors!ConcurrencyError: The maximum number of retries to perform for optimistic concurrency before giving up.
errors!HttpError: Other non-success status code
Protected StaticensureAdds a trailing slash to the URI if it does not already have one.
Endpoint for a resource that can be polled for state changes.