The type of individual elements in the collection.
The type of ElementEndpoint to provide for individual TEntitys.
Creates a new collection endpoint.
The type of individual elements in the collection.
The type of ElementEndpoint to provide for individual TEntitys.
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.
A factory method for creating instances of TElementEndpoint.
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.
The unit used when requesting ranges of elements. Sent in the http!HttpHeader.Range 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 createAll 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 create 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 readAll 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 readRange 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 accepted range units.
Shows whether the server has indicated that setAll 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.
Determines whether the collection contains a specific element.
The ID identifying the entity or an entity to extract the ID from.
errors!HttpError: Other non-success status code
Adds a TEntity as a new element to the collection.
The new TEntity.
Optionalsignal: AbortSignal
Used to cancel the request.
An endpoint for the newly created entity; undefined if the server returned neither a "Location" header nor an entity with an ID in the response body.
errors!HttpError: Other non-success status code
Adds (or updates) multiple TEntitys as elements in the collection.
The TEntitys to create or modify.
Optionalsignal: AbortSignal
Used to cancel the request.
errors!HttpError: Other non-success status code
Deletes an existing element from the collection.
The ID identifying the entity or an entity to extract the ID from.
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
Returns an TElementEndpoint for a specific child element.
The ID identifying the entity or an entity to extract the ID from.
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 element in the collection by merging changes on the server-side.
The TEntity data to merge with the existing element.
The TEntity as returned by the server, possibly with additional fields set. undefined if the server does not respond with a result entity.
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 all TEntitys in the collection.
Optionalsignal: AbortSignal
Used to cancel the request.
errors!HttpError: Other non-success status code
Returns a subset of the TEntitys in the collection.
Optionalfrom: number
The index of the first element to return. Leave unspecified to return the last to elements ("tail").
Optionalto: number
The index of the last element to return. Leave unspecified to return all elements starting at from.
Optionalsignal: AbortSignal
Used to cancel the request.
errors!RangeNotSatisfiableError: http!HttpStatusCode.RangeNotSatisfiable, i.e. the requested range lies outside of the elements currently available
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 an existing element in the collection.
The new state of the element.
The TEntity as returned by the server, possibly with additional fields set. undefined if the server does not respond with a result entity.
errors!HttpError: Other non-success status code
Replaces the entire content of the collection with new TEntitys.
The TEntitys to create or modify.
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 TEntitys, polling the server for elements appended to the collection.
The index of the first element to return. Use a negative value to start with the last -startIndex elements ("tail").
Optionalsignal: AbortSignal
Used to stop polling.
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 collection of
TEntitys observable as an append-only stream using long-polling.Use StreamingCollectionEndpoint instead if you wish to use the default ElementEndpoint type.