Class GenericCollectionEndpoint<TEntity, TElementEndpoint>

Endpoint for a collection of TEntitys addressable as TElementEndpoints.
Use CollectionEndpoint instead if you wish to use the default ElementEndpoint type.

Type Parameters

TEntity

The type of individual elements in the collection.
TElementEndpoint extends ElementEndpoint<TEntity>

The type of ElementEndpoint to provide for individual TEntitys.

Hierarchy

ETagEndpointBase
- GenericCollectionEndpoint
  - CollectionEndpoint

Index

Constructors

constructor

new GenericCollectionEndpoint<TEntity, TElementEndpoint>(referrer: Endpoint, relativeUri: string | URL, elementEndpoint: (new (referrer: Endpoint, uri: URL) => TElementEndpoint)): GenericCollectionEndpoint<TEntity, TElementEndpoint>
Creates a new collection endpoint.
Type Parameters
- TEntity
- TElementEndpoint extends ElementEndpoint<TEntity, TElementEndpoint>
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.
- elementEndpoint: (new (referrer: Endpoint, uri: URL) => TElementEndpoint)
  
  A factory method for creating instances of TElementEndpoint.
  - - new (referrer: Endpoint, uri: URL): TElementEndpoint
    - Parameters
      
      referrer: Endpoint
      
      uri: URL
      
      Returns TElementEndpoint
Returns GenericCollectionEndpoint<TEntity, TElementEndpoint>
Overrides ETagEndpointBase.constructor
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:20

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.

Accessors

createAllAllowed

get createAllAllowed(): undefined | boolean
Shows whether the server has indicated that createAll 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.

Returns undefined | boolean
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:110

createAllowed

get createAllowed(): undefined | boolean
Shows whether the server has indicated that create 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.

Returns undefined | boolean
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:68

readAllAllowed

get readAllAllowed(): undefined | boolean
Shows whether the server has indicated that readAll 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.

Returns undefined | boolean
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:49

setAllAllowed

get setAllAllowed(): undefined | boolean
Shows whether the server has indicated that setAll 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.

Returns undefined | boolean
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:133

Methods

contains

contains(element: string | TEntity): Promise<boolean>
Determines whether the collection contains a specific element.

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
HttpError: Other non-success status code
Parameters
- element: string | TEntity
  
  The ID identifying the entity or an entity to extract the ID from.
Returns Promise<boolean>
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:153

create

create(entity: TEntity, signal?: AbortSignal): Promise<undefined | TElementEndpoint>
Adds a TEntity as a new element to the collection.

Returns
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.

Throws
BadRequestError: BadRequest

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
ConflictError: Conflict

Throws
HttpError: Other non-success status code
Parameters
- entity: TEntity
  
  The new TEntity.
- Optional signal: AbortSignal
  
  Used to cancel the request.
Returns Promise<undefined | TElementEndpoint>
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:81

createAll

createAll(entities: TEntity[], signal?: AbortSignal): Promise<void>
Adds (or updates) multiple TEntitys as elements in the collection.

Throws
BadRequestError: BadRequest

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
ConflictError: Conflict

Throws
HttpError: Other non-success status code
Parameters
- entities: TEntity[]
  
  The TEntitys to create or modify.
- Optional signal: AbortSignal
  
  Used to cancel the request.
Returns Promise<void>
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:122

delete

delete(element: string | TEntity): Promise<void>
Deletes an existing element from the collection.

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
NotFoundError: NotFound or Gone

Throws
HttpError: Other non-success status code
Parameters
- element: string | TEntity
  
  The ID identifying the entity or an entity to extract the ID from.
Returns Promise<void>
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:187

`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>
Inherited from ETagEndpointBase.deleteContent
- Defined in endpoints/generic/ETagEndpointBase.ts:74

get

get(element: string | TEntity): TElementEndpoint
Returns an TElementEndpoint for a specific child element.
Parameters
- element: string | TEntity
  
  The ID identifying the entity or an entity to extract the ID from.
Returns TElementEndpoint
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:29

`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>
Inherited from ETagEndpointBase.getContent
- 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 ETagEndpointBase.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 ETagEndpointBase.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 ETagEndpointBase.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 ETagEndpointBase.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 ETagEndpointBase.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 ETagEndpointBase.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 ETagEndpointBase.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 ETagEndpointBase.linkTemplate
- Defined in endpoints/Endpoint.ts:202

merge

merge(element: TEntity): Promise<undefined | TEntity>
Modifies an existing element in the collection by merging changes on the server-side.

Returns
The TEntity as returned by the server, possibly with additional fields set. undefined if the server does not respond with a result entity.

Throws
BadRequestError: BadRequest

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
NotFoundError: NotFound or Gone

Throws
HttpError: Other non-success status code
Parameters
- element: TEntity
  
  The TEntity data to merge with the existing element.
Returns Promise<undefined | TEntity>
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:177

`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>
Inherited from ETagEndpointBase.putContent
- Defined in endpoints/generic/ETagEndpointBase.ts:55

readAll

readAll(signal?: AbortSignal): Promise<TEntity[]>
Returns all TEntitys in the collection.

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
ConflictError: Conflict

Throws
HttpError: Other non-success status code
Parameters
- Optional signal: AbortSignal
  
  Used to cancel the request.
Returns Promise<TEntity[]>
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:59

`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 ETagEndpointBase.send
- Defined in endpoints/Endpoint.ts:109

set

set(element: TEntity): Promise<undefined | TEntity>
Sets/replaces an existing element in the collection.

Returns
The TEntity as returned by the server, possibly with additional fields set. undefined if the server does not respond with a result entity.

Throws
BadRequestError: BadRequest

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
NotFoundError: NotFound or Gone

Throws
HttpError: Other non-success status code
Parameters
- element: TEntity
  
  The new state of the element.
Returns Promise<undefined | TEntity>
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:165

setAll

setAll(entities: TEntity[]): Promise<void>
Replaces the entire content of the collection with new TEntitys.

Throws
BadRequestError: BadRequest

Throws
AuthenticationError: Unauthorized

Throws
AuthorizationError: Forbidden

Throws
ConflictError: Conflict

Throws
HttpError: Other non-success status code
Parameters
- entities: TEntity[]
  
  The TEntitys to create or modify.
Returns Promise<void>
- Defined in endpoints/generic/GenericCollectionEndpoint.ts:144

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 ETagEndpointBase.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 ETagEndpointBase.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 ETagEndpointBase.ensureTrailingSlash
- Defined in endpoints/Endpoint.ts:93

Class GenericCollectionEndpoint<TEntity, TElementEndpoint>

Type Parameters

TEntity

TElementEndpoint extends ElementEndpoint<TEntity>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TEntity

TElementEndpoint extends ElementEndpoint<TEntity, TElementEndpoint>

Parameters

referrer: Endpoint

relativeUri: string | URL

elementEndpoint: (new (referrer: Endpoint, uri: URL) => TElementEndpoint)

Parameters

referrer: Endpoint

uri: URL

Returns TElementEndpoint

Returns GenericCollectionEndpoint<TEntity, TElementEndpoint>

Properties

Readonly errorHandler

Readonly httpClient

Readonly linkExtractor

Optional responseCache

Readonly serializer

Readonly uri

Accessors

createAllAllowed

Returns

Returns undefined | boolean

createAllowed

Returns

Returns undefined | boolean

readAllAllowed

Returns

Returns undefined | boolean

setAllAllowed

Returns

Returns undefined | boolean

Methods

contains

Throws

Throws

Throws

Parameters

element: string | TEntity

Returns Promise<boolean>

create

Returns

Throws

Throws

Throws

Throws

Throws

Parameters

entity: TEntity

Optional signal: AbortSignal

Returns Promise<undefined | TElementEndpoint>

createAll

Throws

Throws

Throws

Throws

Throws

Parameters

entities: TEntity[]

Optional signal: AbortSignal

Returns Promise<void>

delete

Throws

Throws

Throws

Throws

Parameters

element: string | TEntity

`Readonly` errorHandler

`Readonly` httpClient

`Readonly` linkExtractor

`Optional` responseCache

`Readonly` serializer

`Readonly` uri

`Optional` signal: AbortSignal

`Optional` signal: AbortSignal

`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;
}