Tweaked API documentation

Author: bastianeicher

endpoints/Endpoint.ts

@@ -235,7 +235,7 @@ export class Endpoint {
      * Shows whether the server has indicated that a specific HTTP method is currently allowed.
      * Uses cached data from last response.
      * @param method The HTTP methods (e.g. GET, POST, ...) to check.
-     * @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 `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.
      */
     protected isMethodAllowed(method: HttpMethod): boolean | undefined {
         if (this.allowedMethods.length === 0)

endpoints/generic/ElementEndpoint.ts

@@ -53,7 +53,7 @@ export class ElementEndpoint<TEntity> extends ETagEndpointBase {
     /**
      * Shows whether the server has indicated that {@link set} 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 `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 setAllowed() { return this.isMethodAllowed(HttpMethod.Put); }
 
@@ -79,7 +79,7 @@ export class ElementEndpoint<TEntity> extends ETagEndpointBase {
     /**
      * Shows whether the server has indicated that {@link merge} 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 `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 mergeAllowed() { return this.isMethodAllowed(HttpMethod.Patch); }
 
@@ -135,7 +135,7 @@ export class ElementEndpoint<TEntity> extends ETagEndpointBase {
     /**
      * Shows whether the server has indicated that {@link delete} 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 `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 deleteAllowed() { return this.isMethodAllowed(HttpMethod.Delete); }
 

endpoints/generic/GenericCollectionEndpoint.ts

@@ -43,16 +43,25 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
     /**
      * Shows whether the server has indicated that {@link 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 `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() { return this.isMethodAllowed(HttpMethod.Get); }
 
-    async readAll() { return this.serializer.deserialize<TEntity[]>(await this.getContent()); }
+    /**
+     * Returns all `TEntity`s in the collection.
+     * @throws {@link AuthenticationError}: {@link HttpStatusCode.Unauthorized}
+     * @throws {@link AuthorizationError}: {@link HttpStatusCode.Forbidden}
+     * @throws {@link ConflictError}: {@link HttpStatusCode.Conflict}
+     * @throws {@link HttpError}: Other non-success status code
+     */
+    async readAll() {
+        return this.serializer.deserialize<TEntity[]>(await this.getContent(signal));
+    }
 
     /**
      * Shows whether the server has indicated that {@link 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 `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() { return this.isMethodAllowed(HttpMethod.Post); }
 
@@ -82,7 +91,7 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
     /**
      * Shows whether the server has indicated that {@link 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 `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 createAllAllowed() { return this.isMethodAllowed(HttpMethod.Patch); }
 
@@ -104,7 +113,7 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
     /**
      * Shows whether the server has indicated that {@link 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 `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() { return this.isMethodAllowed(HttpMethod.Put); }
 

endpoints/raw/BlobEndpoint.ts

@@ -23,7 +23,7 @@ export class BlobEndpoint extends Endpoint {
     /**
      * Shows whether the server has indicated that {@link download} 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 `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 downloadAllowed() { return this.isMethodAllowed(HttpMethod.Get); }
 
@@ -43,7 +43,7 @@ export class BlobEndpoint extends Endpoint {
     /**
      * Shows whether the server has indicated that {@link upload} 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 `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 uploadAllowed() { return this.isMethodAllowed(HttpMethod.Put); }
 
@@ -60,7 +60,7 @@ export class BlobEndpoint extends Endpoint {
     /**
      * Shows whether the server has indicated that {@link delete} 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 `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 deleteAllowed() { return this.isMethodAllowed(HttpMethod.Delete); }
 

endpoints/rpc/RpcEndpointBase.ts

@@ -26,7 +26,7 @@ export class RpcEndpointBase extends Endpoint {
     /**
      * Shows whether the server has indicated that the invoke 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.
+     * @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.
      */
     get invokeAllowed() { return this.isMethodAllowed(HttpMethod.Post); }
 }