Options
All
  • Public
  • Public/Protected
  • All
Menu

Endpoint for a collection of TEntitys addressable as ElementEndpoint<TEntity>s.
Use GenericCollectionEndpoint instead if you wish to customize the element endpoint type.

Type Parameters

  • TEntity

    The type of individual elements in the collection.

Hierarchy

Index

Constructors

Properties

errorHandler: ErrorHandler

Handles errors in responses.

httpClient: HttpClient

The HTTP client used to communicate with the remote resource.

linkExtractor: LinkExtractor

Extracts links from responses.

responseCache?: ResponseCache

A cached copy of the last response.

serializer: Serializer

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

uri: URL

The HTTP URI of the remote resource.

Accessors

  • get createAllAllowed(): undefined | boolean
  • Shows whether the server has indicated that createAll is currently allowed. Uses cached data from last response.

    Returns undefined | boolean

    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.

  • get createAllowed(): undefined | boolean
  • Shows whether the server has indicated that create is currently allowed. Uses cached data from last response.

    Returns undefined | boolean

    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.

  • get readAllAllowed(): undefined | boolean
  • Shows whether the server has indicated that readAll is currently allowed. Uses cached data from last response.

    Returns undefined | boolean

    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.

  • get setAllAllowed(): undefined | boolean
  • Shows whether the server has indicated that setAll is currently allowed. Uses cached data from last response.

    Returns undefined | boolean

    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.

Methods

  • contains(element: string | TEntity): Promise<boolean>
  • create(entity: TEntity, signal?: AbortSignal): Promise<undefined | ElementEndpoint<TEntity>>
  • createAll(entities: TEntity[], signal?: AbortSignal): Promise<void>
  • delete(element: string | TEntity): Promise<void>
  • deleteContent(signal?: AbortSignal): Promise<Response>
  • getContent(signal?: AbortSignal): Promise<string>
  • getLinkTemplate(rel: string): string
  • getLinks(rel: string): { title?: string; uri: URL }[]
  • handle(response: Response): Promise<void>
  • handleCapabilities(response: Response): void
  • 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.

    Parameters

    • method: HttpMethod

      The HTTP methods (e.g. GET, POST, ...) to check.

    Returns undefined | boolean

    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.

  • 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

  • link(rel: string): URL
  • linkTemplate(rel: string, variables: {}): 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: {}

      Variables for resolving the template.

      • [key: string]: any

    Returns URL

  • merge(element: TEntity): Promise<undefined | TEntity>
  • putContent(content: any, signal?: AbortSignal): Promise<Response>
  • readAll(signal?: AbortSignal): Promise<TEntity[]>
  • 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>

  • set(element: TEntity): Promise<undefined | TEntity>
  • setAll(entities: TEntity[]): Promise<void>
  • 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

  • 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

  • ensureTrailingSlash(uri: string | URL): URL

Generated using TypeDoc