Class ETagEndpointBase

Base class for building endpoints that use ETags (entity tags) for caching and to avoid lost updates.

Hierarchy

Endpoint
- ETagEndpointBase
  - GenericCollectionEndpoint
  - ElementEndpoint

Implements

CachingEndpoint

Index

Constructors

constructor

new ETagEndpointBase(referrer: Endpoint, relativeUri: string | URL): ETagEndpointBase
Creates a new endpoint.
Parameters
- referrer: Endpoint
  
  The endpoint used to navigate to this one.
- relativeUri: string | URL
  
  The URI of this endpoint relative to the referrer's. Add a ./ prefix here to imply a trailing slash in the referrer's URI.
Returns ETagEndpointBase
Overrides Endpoint.constructor
- Defined in endpoints/generic/ETagEndpointBase.ts:14

Properties

`Readonly` errorHandler

errorHandler: ErrorHandler

Handles errors in responses.

`Readonly` httpClient

httpClient: HttpClient

The HTTP client used to communicate with the remote resource.

`Readonly` linkExtractor

linkExtractor: LinkExtractor

Extracts links from responses.

`Optional` responseCache

responseCache?: ResponseCache

A cached copy of the last response.

`Readonly` serializer

serializer: Serializer

Controls the serialization of entities sent to and received from the server.

`Readonly` uri

uri: URL

The HTTP URI of the remote resource.

Methods

`Protected` deleteContent

deleteContent(signal?: AbortSignal): Promise<Response>
Performs an Delete request on the uri. Sets IfMatch if there is a cached ETag to detect lost updates.

Throws
ConcurrencyError: The entity has changed since it was last retrieved with getContent. Your changes were rejected to prevent a lost update.

Throws
BadRequestError: BadRequest

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
NotFoundError: NotFound or Gone

Throws
HttpError: Other non-success status code
Parameters
- Optional signal: AbortSignal
  
  Used to cancel the request.
Returns Promise<Response>
- Defined in endpoints/generic/ETagEndpointBase.ts:74

`Protected` getContent

getContent(signal?: AbortSignal): Promise<string>
Performs an Put request on the uri and caches the response if the server sends an ETag.

Throws
BadRequestError: BadRequest

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
NotFoundError: NotFound or Gone

Throws
HttpError: Other non-success status code
Parameters
- Optional signal: AbortSignal
  
  Used to cancel the request.
Returns Promise<string>
- Defined in endpoints/generic/ETagEndpointBase.ts:32

getLinkTemplate

getLinkTemplate(rel: string): string
Retrieves a link template with a specific relation type. Uses cached data from last response. Prefer linkTemplate when possible.

Throws
NotFoundError: No link template with the specified rel could be found.
Parameters
- rel: string
  
  The relation type of the link template to look for.
Returns string
Inherited from Endpoint.getLinkTemplate
- Defined in endpoints/Endpoint.ts:212

getLinks

getLinks(rel: string): {
title?: string;
uri: URL;
}[]
Resolves all links with a specific relation type. Uses cached data from last response.
Parameters
- rel: string
  
  The relation type of the links to look for.
Returns {
title?: string;
uri: URL;
}[]
Inherited from Endpoint.getLinks
- Defined in endpoints/Endpoint.ts:167

`Protected` handle

handle(response: Response): Promise<void>
Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors.

Throws
HttpError
Parameters
- response: Response
  
  The response to process.
Returns Promise<void>
Inherited from Endpoint.handle
- Defined in endpoints/Endpoint.ts:120

`Protected` handleCapabilities

handleCapabilities(response: Response): void
Handles allowed HTTP methods and other capabilities reported by the server.
Parameters
- response: Response
Returns void
Inherited from Endpoint.handleCapabilities
- Defined in endpoints/Endpoint.ts:228

`Protected` isMethodAllowed

isMethodAllowed(method: HttpMethod): undefined | boolean
Shows whether the server has indicated that a specific HTTP method is currently allowed. Uses cached data from last response.

Returns
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.
Parameters
- method: HttpMethod
  
  The HTTP methods (e.g. GET, POST, ...) to check.
Returns undefined | boolean
Inherited from Endpoint.isMethodAllowed
- Defined in endpoints/Endpoint.ts:241

`Protected` join

join(relativeUri: string): URL
Resolves a relative URI using this endpoint's URI as the base.
Parameters
- relativeUri: string
  
  The relative URI to resolve. Prepend ./ to imply a trailing slash in the base URI even if it is missing there.
Returns URL
Inherited from Endpoint.join
- Defined in endpoints/Endpoint.ts:84

link

link(rel: string): URL
Resolves a single link with a specific relation type. Uses cached data from last response.

Throws
NotFoundError: No link with the specified rel could be found.
Parameters
- rel: string
  
  The relation type of the link to look for.
Returns URL
Inherited from Endpoint.link
- Defined in endpoints/Endpoint.ts:187

linkTemplate

linkTemplate(rel: string, variables: {
[key: string]: any;
}): URL
Resolves a link template with a specific relation type. Uses cached data from last response.

Throws
NotFoundError: No link template with the specified rel could be found.
Parameters
- rel: string
  
  The relation type of the link template to look for.
- variables: {
  [key: string]: any;
  }
  
  Variables for resolving the template.
  - [key: string]: any
Returns URL
Inherited from Endpoint.linkTemplate
- Defined in endpoints/Endpoint.ts:202

`Protected` putContent

putContent(content: any, signal?: AbortSignal): Promise<Response>
Performs an Put request on the uri. Sets IfMatch if there is a cached ETag to detect lost updates.

Throws
ConcurrencyError: The entity has changed since it was last retrieved with getContent. Your changes were rejected to prevent a lost update.

Throws
BadRequestError: BadRequest

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
NotFoundError: NotFound or Gone

Throws
HttpError: Other non-success status code
Parameters
- content: any
- Optional signal: AbortSignal
  
  Used to cancel the request.
Returns Promise<Response>
- Defined in endpoints/generic/ETagEndpointBase.ts:55

`Protected` send

send(method: HttpMethod, signal?: AbortSignal, headers?: HeadersInit, body?: BodyInit): Promise<Response>
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.

Throws
HttpError
Parameters
- method: HttpMethod
  
  The HTTP method to use.
- Optional signal: AbortSignal
  
  Used to cancel the request.
- Optional headers: HeadersInit
  
  The HTTP headers to set.
- Optional body: BodyInit
  
  The body to send.
Returns Promise<Response>
Inherited from Endpoint.send
- Defined in endpoints/Endpoint.ts:109

setDefaultLink

setDefaultLink(rel: string, href?: string): void
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.
Parameters
- rel: string
  
  The relation type of the link to add.
- Optional href: string
  
  The href of the link relative to this endpoint's URI. Leave unspecified to remove any previous entries for the relation type.
Returns void
Inherited from Endpoint.setDefaultLink
- Defined in endpoints/Endpoint.ts:140

setDefaultLinkTemplate

setDefaultLinkTemplate(rel: string, href?: string): void
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.
Parameters
- rel: string
  
  The relation type of the link to add.
- Optional href: string
  
  The templates href relative to this endpoint's URI. Leave unspecified to remove any previous entries for the relation type.
Returns void
Inherited from Endpoint.setDefaultLinkTemplate
- Defined in endpoints/Endpoint.ts:155

`Static` `Protected` ensureTrailingSlash

ensureTrailingSlash(uri: string | URL): URL
Adds a trailing slash to the URI if it does not already have one.
Parameters
- uri: string | URL
Returns URL
Inherited from Endpoint.ensureTrailingSlash
- Defined in endpoints/Endpoint.ts:93

Class ETagEndpointBase

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

referrer: Endpoint

relativeUri: string | URL

Returns ETagEndpointBase

Properties

Readonly errorHandler

Readonly httpClient

Readonly linkExtractor

Optional responseCache

Readonly serializer

Readonly uri

Methods

Protected deleteContent

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

Optional signal: AbortSignal

Returns Promise<Response>

Protected getContent

Throws

Throws

Throws

Throws

Throws

Parameters

Optional signal: AbortSignal

Returns Promise<string>

getLinkTemplate

Throws

Parameters

rel: string

Returns string

getLinks

Parameters

rel: string

Returns { title?: string; uri: URL; }[]

Protected handle

Throws

Parameters

response: Response

Returns Promise<void>

Protected handleCapabilities

Parameters

response: Response

Returns void

Protected isMethodAllowed

Returns

Parameters

method: HttpMethod

Returns undefined | boolean

Protected join

Parameters

relativeUri: string

Returns URL

link

Throws

Parameters

rel: string

Returns URL

linkTemplate

Throws

Parameters

rel: string

variables: { [key: string]: any; }

[key: string]: any

Returns URL

Protected putContent

`Readonly` errorHandler

`Readonly` httpClient

`Readonly` linkExtractor

`Optional` responseCache

`Readonly` serializer

`Readonly` uri

`Protected` deleteContent

`Optional` signal: AbortSignal

`Protected` getContent

`Optional` signal: AbortSignal

Returns {
title?: string;
uri: URL;
}[]

`Protected` handle

`Protected` handleCapabilities

`Protected` isMethodAllowed

`Protected` join

variables: {
[key: string]: any;
}

`Protected` putContent

`Optional` signal: AbortSignal

`Protected` send

`Optional` signal: AbortSignal

`Optional` headers: HeadersInit

`Optional` body: BodyInit

`Optional` href: string

`Optional` href: string

`Static` `Protected` ensureTrailingSlash