Strip "ById", change "undefined" for "null", fix syntax errors

Author: christophfriedrich

CHANGELOG.md

@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - New property `id` added to `FederationBackend` objects returned by `listFederation` in `Capabilities`
-- New functions `getFederationBackendById` and `getFederationBackendsByIds` in `Capabilities`
+- New functions `getFederationBackend` and `getFederationBackends` in `Capabilities`
 
 ## [2.7.0] - 2025-01-04
 

openeo.d.ts

@@ -412,17 +412,17 @@ declare module OpenEO {
         /**
          * Given just the string ID of a backend within the federation, returns that backend's full details as a FederationBackend object
          * 
-         * @param {string} backendId The ID of a backend within the federation
-         * @returns {FederationBackend} The full details of the backend, or `undefined` if no backend with the given ID exists
+         * @param {string} backendId - The ID of a backend within the federation
+         * @returns {FederationBackend} The full details of the backend, or `null` if no backend with the given ID exists
          */
-        getFederationBackendById(backendId: string): FederationBackend | undefined;
+        getFederationBackend(backendId: string): FederationBackend | null;
         /**
          * Given a list of string IDs of backends within the federation, returns those backends' full details as FederationBackend objects
          * 
-         * @param {Array<string>} backendIds The IDs of backends within the federation
-         * @returns {Array<FederationBackend>} An array in the same order as the input, containing for each position either the full details of the backend, or `undefined` if no backend with the given ID exists
+         * @param {Array<string>} backendIds - The IDs of backends within the federation
+         * @returns {Array<FederationBackend>} An array in the same order as the input, containing for each position either the full details of the backend, or `null` if no backend with the given ID exists
          */
-        getFederationBackendsByIds(backendIds: Array<string>): Array<FederationBackend | undefined>;
+        getFederationBackends(backendIds: Array<string>): Array<FederationBackend | null>;
         /**
          * Lists all supported features.
          *

src/capabilities.js

@@ -212,23 +212,23 @@ class Capabilities {
 	/**
 	 * Given just the string ID of a backend within the federation, returns that backend's full details as a FederationBackend object
 	 * 
-	 * @param {string} backendId The ID of a backend within the federation
-	 * @returns {FederationBackend | undefined} The full details of the backend, or `undefined` if no backend with the given ID exists
+	 * @param {string} backendId - The ID of a backend within the federation
+	 * @returns {FederationBackend | null} The full details of the backend, or `null` if no backend with the given ID exists
 	 */
-	getFederationBackendById(backendId) {
-		// Add `id` property to make it a proper FederationBackend object, but check for undefined case beforehand
-		return this.data.federation[backendId] ? { id: backendId, ...this.data.federation[backendId] } : undefined;
+	getFederationBackend(backendId) {
+		// Add `id` property to make it a proper FederationBackend object, but check for null case beforehand
+		return this.data.federation[backendId] ? { id: backendId, ...this.data.federation[backendId] } : null;
 	}
 
 	/**
 	 * Given a list of string IDs of backends within the federation, returns those backends' full details as FederationBackend objects
 	 * 
-	 * @param {Array<string>} backendIds The IDs of backends within the federation
-	 * @returns {Array<FederationBackend | undefined>} An array in the same order as the input, containing for each position either the full details of the backend, or `undefined` if no backend with the given ID exists
+	 * @param {Array<string>} backendIds - The IDs of backends within the federation
+	 * @returns {Array<FederationBackend | null>} An array in the same order as the input, containing for each position either the full details of the backend, or `null` if no backend with the given ID exists
 	 */
-	getFederationBackendsByIds(backendIds) {
+	getFederationBackends(backendIds) {
 		// Let 'single case' function do the work, but pass `this` so that `this.data.federation` can be accessed in the callback context
-		return backendIds.map(this.getFederationBackendById, this);
+		return backendIds.map(this.getFederationBackend, this);
 	}
 
 	/**