Class Endpoint

Hierarchy (View Summary)

Endpoint

Index

Constructors

Properties

errorHandler httpClient linkExtractor serializer uri

Methods

getLinks getLinkTemplate handle handleCapabilities isMethodAllowed join link linkTemplate send setDefaultLink setDefaultLinkTemplate ensureTrailingSlash

Constructors

constructor

new Endpoint(
    referrer: Endpoint | undefined,
    uri: string | URL,
    serializer?: Serializer,
    errorHandler?: ErrorHandler,
    linkExtractor?: LinkExtractor,
    httpClient?: HttpClient,
): Endpoint
Creates a new endpoint.
Parameters
- referrer: Endpoint | undefined
  The endpoint used to navigate to this one. Must be defined except for top-level endpoint.
- uri: string | URL
  The HTTP URI of the remote element. May be relative if referrer is defined.
- Optionalserializer: Serializer
  Controls the serialization of entities sent to and received from the server. Taken from referrer instead if it is defined.
- OptionalerrorHandler: ErrorHandler
  Handles errors in responses. Taken from referrer instead if it is defined.
- OptionallinkExtractor: LinkExtractor
  Extracts links from responses. Taken from referrer instead if it is defined.
- OptionalhttpClient: HttpClient
  The HTTP client used to communicate with the remote resource. Taken from referrer instead if it is defined.
Returns Endpoint
- Defined in endpoints/Endpoint.ts:42

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.

`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

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 }[]
- Defined in endpoints/Endpoint.ts:167

getLinkTemplate

getLinkTemplate(rel: string): string
Retrieves a link template with a specific relation type. Uses cached data from last response. Prefer linkTemplate when possible.
Parameters
- rel: string
  The relation type of the link template to look for.
Returns string
Throws
errors!NotFoundError: No link template with the specified rel could be found.
- Defined in endpoints/Endpoint.ts:212

`Protected`handle

handle(response: Response): Promise<void>
Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors.
Parameters
- response: Response
  The response to process.
Returns Promise<void>
Throws
errors!HttpError
- 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
- Defined in endpoints/Endpoint.ts:228

`Protected`isMethodAllowed

isMethodAllowed(method: HttpMethod): boolean | undefined
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 boolean | undefined
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.
- 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
- 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.
Parameters
- rel: string
  The relation type of the link to look for.
Returns URL
Throws
errors!NotFoundError: No link with the specified rel could be found.
- 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.
Parameters
- rel: string
  The relation type of the link template to look for.
- variables: { [key: string]: any }
  Variables for resolving the template.
Returns URL
Throws
errors!NotFoundError: No link template with the specified rel could be found.
- Defined in endpoints/Endpoint.ts:202

`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.
Parameters
- method: HttpMethod
  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.
Returns Promise<Response>
Throws
errors!HttpError
- 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.
- Optionalhref: 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
- 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.
- Optionalhref: string
  The templates href relative to this endpoint's URI. Leave unspecified to remove any previous entries for the relation type.
Returns void
- Defined in endpoints/Endpoint.ts:155

`Protected` `Static`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
- Defined in endpoints/Endpoint.ts:93

Class Endpoint

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Endpoint

Properties

ReadonlyerrorHandler

ReadonlyhttpClient

ReadonlylinkExtractor

Readonlyserializer

Readonlyuri

Methods

getLinks

Parameters

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

getLinkTemplate

Parameters

Returns string

Throws

Protectedhandle

Parameters

Returns Promise<void>

Throws

ProtectedhandleCapabilities

Parameters

Returns void

ProtectedisMethodAllowed

Parameters

Returns boolean | undefined

Protectedjoin

Parameters

Returns URL

link

Parameters

Returns URL

Throws

linkTemplate

Parameters

Returns URL

Throws

Protectedsend

Parameters

Returns Promise<Response>

Throws

setDefaultLink

Parameters

Returns void

setDefaultLinkTemplate

Parameters

Returns void

Protected StaticensureTrailingSlash

Parameters

Returns URL

Settings

On This Page

`Readonly`errorHandler

`Readonly`httpClient

`Readonly`linkExtractor

`Readonly`serializer

`Readonly`uri

`Protected`handle

`Protected`handleCapabilities

`Protected`isMethodAllowed

`Protected`join

`Protected`send

`Protected` `Static`ensureTrailingSlash