Improved EntryEndpoint constructor argument order and documentation

Author: bastianeicher

endpoints/Endpoint.ts

@@ -35,23 +35,20 @@ export class Endpoint {
      * Creates a new endpoint.
      * @param referrer The endpoint used to navigate to this one. Must be defined except for top-level endpoint.
      * @param uri The HTTP URI of the remote element. May be relative if `referrer` is defined.
-     * @param httpClient The HTTP client used to communicate with the remote resource. Taken from `referrer` instead if it is defined.
      * @param serializer Controls the serialization of entities sent to and received from the server. Taken from `referrer` instead if it is defined.
      * @param errorHandler Handles errors in responses. Taken from `referrer` instead if it is defined.
      * @param linkExtractor Extracts links from responses. Taken from `referrer` instead if it is defined.
+     * @param httpClient The HTTP client used to communicate with the remote resource. Taken from `referrer` instead if it is defined.
      */
     constructor(
         referrer: Endpoint | undefined,
         uri: URL | string,
-        httpClient?: HttpClient,
         serializer?: Serializer,
         errorHandler?: ErrorHandler,
-        linkExtractor?: LinkExtractor) {
+        linkExtractor?: LinkExtractor,
+        httpClient?: HttpClient) {
         if (referrer) {
             this.uri = (typeof uri === "string") ? referrer.join(uri) : uri;
-            if (httpClient)
-                throw new Error("httpClient must not be specified if referrer is not specified.");
-            this.httpClient = referrer.httpClient;
             if (serializer)
                 throw new Error("serializer must not be specified if referrer is not specified.");
             this.serializer = referrer.serializer;
@@ -61,11 +58,11 @@ export class Endpoint {
             if (linkExtractor)
                 throw new Error("linkExtractor must not be specified if referrer is not specified.");
             this.linkExtractor = referrer.linkExtractor;
+            if (httpClient)
+                throw new Error("httpClient must not be specified if referrer is not specified.");
+            this.httpClient = referrer.httpClient;
         } else {
             this.uri = (typeof uri === "string") ? new URL(uri) : uri;
-            if (!httpClient)
-                throw new Error("httpClient must be specified if referrer is not specified.");
-            this.httpClient = httpClient;
             if (!serializer)
                 throw new Error("serializer must be specified if referrer is not specified.");
             this.serializer = serializer;
@@ -75,6 +72,9 @@ export class Endpoint {
             if (!linkExtractor)
                 throw new Error("linkExtractor must be specified if referrer is not specified.");
             this.linkExtractor = linkExtractor;
+            if (!httpClient)
+                throw new Error("httpClient must be specified if referrer is not specified.");
+            this.httpClient = httpClient;
         }
     }
 

endpoints/EntryEndpoint.ts

@@ -10,24 +10,24 @@ import { LinkExtractor, AggregateLinkExtractor, HeaderLinkExtractor, HalLinkExtr
 export class EntryEndpoint extends Endpoint {
     /**
      * Creates a new entry endpoint.
-     * @param uri The base URI of the REST API. Missing trailing slash will be appended automatically
-     * @param httpClient The HTTP client used to communicate with the REST API.
-     * @param serializer Controls the serialization of entities sent to and received from the server. Defaults to {@link JsonSerializer} if unset.</param>
-     * @param errorHandler Handles errors in HTTP responses. Defaults to {@link DefaultErrorHandler} if unset.</param>
-     * @param linkExtractor Detects links in HTTP responses. Combines {@link HeaderLinkExtractor} and {@link HalLinkExtractor} if unset.</param>
+     * @param uri The base URI of the REST API.<br>Missing trailing slash will be appended automatically.
+     * @param serializer Controls the serialization of entities sent to and received from the server.<br>Defaults to {@link JsonSerializer} if undefined.
+     * @param errorHandler Handles errors in HTTP responses.<br>Defaults to {@link DefaultErrorHandler} if undefined.
+     * @param linkExtractor Detects links in HTTP responses.<br>Defaults to {@link HeaderLinkExtractor} and {@link HalLinkExtractor} combined via {@link AggregateLinkExtractor} if undefined.
+     * @param httpClient The HTTP client used to communicate with the REST API.<br>Defaults to {@link FetchHttpClient} if undefined.
      */
     constructor(
         uri: URL | string,
-        httpClient?: HttpClient,
         serializer?: Serializer,
         errorHandler?: ErrorHandler,
-        linkExtractor?: LinkExtractor) {
+        linkExtractor?: LinkExtractor,
+        httpClient?: HttpClient) {
         super(undefined,
             Endpoint.ensureTrailingSlash(uri),
-            httpClient ?? new FetchHttpClient(),
             serializer ?? new JsonSerializer(),
             errorHandler ?? new DefaultErrorHandler(),
-            linkExtractor ?? new AggregateLinkExtractor(new HeaderLinkExtractor(), new HalLinkExtractor()));
+            linkExtractor ?? new AggregateLinkExtractor(new HeaderLinkExtractor(), new HalLinkExtractor()),
+            httpClient ?? new FetchHttpClient());
 
         for (const mediaType of this.serializer.supportedMediaTypes) {
             this.httpClient.defaultHeaders.append(HttpHeader.Accept, mediaType);