The type of entity the endpoint takes as input.
The type of entity the endpoint returns as output.
Creates a new function endpoint.
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.
Handles errors in responses.
The HTTP client used to communicate with the remote resource.
Extracts links from responses.
Controls the serialization of entities sent to and received from the server.
The HTTP URI of the remote resource.
Shows whether the server has indicated that the invoke method 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.
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.
Resolves all links with a specific relation type. Uses cached data from last response.
The relation type of the links to look for.
Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors.
The response to process.
Handles allowed HTTP methods and other capabilities reported by the server.
Invokes the function.
The TEntity to post as input.
Used to cancel the request.
The TResult returned by the server.
Shows 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.
Resolves 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.
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.
Queries the server about capabilities of the endpoint without performing any action.
Used to cancel the request.
Sends 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.
Used to cancel the request.
The HTTP headers to set.
The body to send.
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.
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.
Adds a trailing slash to the URI if it does not already have one.
Generated using TypeDoc
RPC endpoint that takes
TEntityas input and returnsTResultas output when invoked.